diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e8d16bca..d5cdfc1f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -6,15 +6,22 @@ on: pull_request: branches: [ main, maint-0.x ] +permissions: + contents: read + jobs: test-python-312-single-user: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 + with: + # Full history and tags so setuptools-scm derives the real version + # for the distribution built by `make test-dist`. + fetch-depth: 0 - name: Set up Python 3.12 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.12" @@ -27,7 +34,7 @@ jobs: run: make lint - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: make certs @@ -44,7 +51,7 @@ jobs: run: NIPYAPI_PROFILE=single-user PYTHONPATH=${{ github.workspace }}:$PYTHONPATH pytest --cov=nipyapi --cov-report=xml --cov-report=term-missing - name: Upload coverage to Codecov - uses: codecov/codecov-action@v4 + uses: codecov/codecov-action@v7 with: files: ./coverage.xml fail_ci_if_error: false @@ -59,13 +66,13 @@ jobs: run: make down test-python-311-single-user: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 - name: Set up Python 3.11 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.11" @@ -75,7 +82,7 @@ jobs: pip install -e .[dev] - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: make certs @@ -94,13 +101,13 @@ jobs: run: make down test-python-310-single-user: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 - name: Set up Python 3.10 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.10" @@ -110,7 +117,7 @@ jobs: pip install -e .[dev] - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: make certs @@ -129,13 +136,13 @@ jobs: run: make down test-python-39-single-user: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 - name: Set up Python 3.9 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.9" @@ -145,7 +152,7 @@ jobs: pip install -e .[dev] - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: make certs @@ -164,13 +171,13 @@ jobs: run: make down test-python-312-secure-ldap: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 - name: Set up Python 3.12 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.12" @@ -180,7 +187,7 @@ jobs: pip install -e .[dev] - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: make certs @@ -219,14 +226,14 @@ jobs: run: make down test-python-312-secure-mtls: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 # Note: This test can be flakey in local CI environments steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v7 - name: Set up Python 3.12 - uses: actions/setup-python@v4 + uses: actions/setup-python@v7 with: python-version: "3.12" @@ -236,7 +243,7 @@ jobs: pip install -e .[dev] - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Generate certificates run: | diff --git a/Makefile b/Makefile index 29ea9c51..65c1b8b0 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,8 @@ -.PHONY: clean clean-pyc clean-build clean-act clean-docker test docs help +.PHONY: clean clean-all clean-temp clean-certs clean-generated clean-pyc clean-build clean-act clean-docker install dist wheel sdist check-dist test-dist test docs help .DEFAULT_GOAL := help # Default NiFi/Registry version for docker compose profiles -NIFI_VERSION ?= 2.10.0 +NIFI_VERSION ?= 2.12.0 # Load .env file if it exists (for secrets like GH_REGISTRY_TOKEN) # WARNING: All variables from .env are exported and can override profile settings. @@ -95,35 +95,37 @@ help: ## Operational Targets ## ################################################################################# -clean: clean-build clean-pyc clean-temp ## remove all build, test, coverage and Python artifacts +clean: clean-build clean-pyc clean-temp ## remove build, coverage and Python artifacts (keeps test certificates) -clean-all: clean-build clean-pyc clean-temp openapi-clean ## nuclear clean: removes ALL artifacts including committed generated code - @echo "=== Nuclear Clean: Removing ALL Artifacts ===" +clean-all: clean-build clean-pyc clean-temp clean-certs openapi-clean clean-generated ## nuclear clean: removes ALL artifacts including committed generated code + @echo "ALL artifacts removed: build, Python, OpenAPI, committed code, test certificates." + @echo "Use 'make certs', 'make gen-clients' and 'make docs' to regenerate them." + +clean-generated: ## remove committed generated code (API clients, structured docs); nipyapi cannot be imported until 'make gen-clients' @echo "WARNING: This removes committed generated code (API clients, docs)!" # Generated API clients (committed code) rm -rf nipyapi/nifi/* nipyapi/registry/* || true # Generated documentation (committed code) rm -rf docs/nipyapi-docs || true - @echo "ALL artifacts removed: build, Python, OpenAPI, committed code, test certificates." - @echo "Use 'make openapi-generate' and 'make docs' to regenerate committed code." -clean-temp: ## remove temporary artifacts but preserve committed code +clean-temp: ## remove coverage, docs build and generation temp files; preserves committed code and test certificates # Coverage artifacts rm -rf htmlcov/ .coverage coverage.xml .pytest_cache || true # Documentation build artifacts rm -rf docs/_build/* || true # Temporary generation files and cache rm -rf resources/client_gen/_tmp/* resources/client_gen/_cache/* || true - # Test certificates and configuration (non-committed test artifacts) + +clean-certs: ## remove generated test certificates and env files (regenerate with 'make certs') rm -rf resources/certs/ca/ resources/certs/nifi/ resources/certs/registry/ resources/certs/client/ resources/certs/truststore/ || true rm -f resources/certs/certs.env resources/certs/nifi.env resources/certs/registry.env || true - # Auto-generated version file - rm -f nipyapi/_version.py || true clean-build: ## remove build artifacts rm -fr build/ rm -fr dist/ rm -fr .eggs/ + # Auto-generated version file (rewritten by setuptools-scm on build) + rm -f nipyapi/_version.py || true find . -path ./.venv -prune -o -name '*.egg-info' -exec rm -fr {} + find . -path ./.venv -prune -o -name '*.egg' -exec rm -rf {} + @@ -157,7 +159,7 @@ clean-docker: clean-act ## comprehensive Docker cleanup: act + containers + volu docker volume prune -f || true @echo "Comprehensive Docker cleanup complete" -install: clean ## install the package to the active Python's site-packages +install: clean-build ## install the package to the active Python's site-packages $(PIP) install . dev-install: ## install dev extras for local development @@ -313,19 +315,21 @@ test-specific: ## DEPRECATED: use 'make test PYTEST_ARGS="..."' instead # Build & Documentation -dist: clean ## builds source and wheel package using modern build system +dist: clean-build ## builds source and wheel package using modern build system $(PYTHON) -m build -wheel: clean ## builds wheel package only +wheel: clean-build ## builds wheel package only $(PYTHON) -m build --wheel -sdist: clean ## builds source distribution only +sdist: clean-build ## builds source distribution only $(PYTHON) -m build --sdist -check-dist: dist ## validate distribution files +check-dist: ## validate distribution files (builds dist only if dist/ is empty) + @ls dist/*.whl >/dev/null 2>&1 || $(MAKE) dist $(PYTHON) -m twine check dist/* -test-dist: dist ## test that built distribution can be imported and used +test-dist: ## test that built distribution can be imported and used (builds dist only if dist/ is empty) + @ls dist/*.whl >/dev/null 2>&1 || $(MAKE) dist $(PYTHON) resources/scripts/test_distribution.py docs: ## generate Sphinx HTML documentation with improved navigation @@ -367,17 +371,18 @@ sandbox: ensure-certs ## create isolated environment with sample objects: make s rebuild-all: ## comprehensive rebuild: clean -> certs -> extract APIs -> gen clients -> test all -> build -> validate -> docs @echo "Starting comprehensive rebuild from clean slate..." - @echo "=== 1/9: Clean All Artifacts ===" - $(MAKE) clean-all + @echo "=== 1/9: Clean All Artifacts (generated code is removed at step 5) ===" + $(MAKE) clean-build clean-pyc clean-temp clean-certs openapi-clean @echo "=== 2/9: Generate Certificates ===" $(MAKE) certs @echo "=== 3/9: Extract OpenAPI Specs ===" $(MAKE) up NIPYAPI_PROFILE=single-user $(MAKE) wait-ready NIPYAPI_PROFILE=single-user - $(MAKE) fetch-openapi + $(MAKE) fetch-openapi-base @echo "=== 4/9: Augment OpenAPI Specs ===" $(MAKE) augment-openapi @echo "=== 5/9: Generate Fresh Clients ===" + $(MAKE) clean-generated $(MAKE) gen-clients @echo "=== 6/9: Test All Profiles with Fresh Clients ===" $(MAKE) test-all diff --git a/docs/contributing.rst b/docs/contributing.rst index 240fcc17..d53eb8d3 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -332,8 +332,9 @@ NiPyAPI uses Makefile targets as the primary automation interface. Run ``make he make dev-install # Install with dev dependencies (uses uv if available, pip otherwise) make docs-install # Install documentation dependencies - make clean # Remove build, pyc, and temp artifacts - make clean-all # Nuclear clean: removes ALL including generated code + make clean # Remove build, pyc, coverage and temp artifacts (keeps test certificates) + make clean-certs # Remove generated test certificates (regenerate with make certs) + make clean-all # Nuclear clean: removes ALL including certificates and generated code **Testing Workflow** :: diff --git a/docs/history.rst b/docs/history.rst index 31199e1c..fa2b1cb1 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,57 @@ History ======= +1.8.0 (2026-10-22) +------------------- + +| NiFi 2.12.0 support, parameter provider helpers and behaviour fixes + +**Behaviour Changes** + +This is a minor release: no public function was removed or had its signature changed, but the following existing functions now behave differently. Review callers of ``get_process_group`` in particular. + +- **get_process_group** (high-traffic): a lookup by an ID that does not exist now returns ``None`` instead of raising ``ValueError("Unable to locate group ...")``. Code that caught ``ValueError`` to detect a missing group should check for ``None`` instead. Other API errors still raise ``ValueError``, and lookups by name are unchanged. The ``nipyapi.ci`` commands report a missing group as ``Process group not found: ``. See Bug Fixes. +- **Parameter context updates**: ``update_parameter_context``, and the helpers that call it (``rename_parameter_context``, ``upsert_parameter_to_context``, ``delete_parameter_from_context`` and ``update_parameter_in_context``), now raise ``ValueError`` when the update request completes with a ``failureReason``. Previously the failure was ignored and the re-read context was returned as if the update had succeeded. +- **verify_controller and verify_processor**: a verification request that completes with a ``failureReason`` now raises ``ValueError``. A timeout or interruption no longer sends a DELETE that would cancel the server-side request, and an error deleting a completed request now propagates instead of being logged and ignored. Individual ``FAILED`` verification results are still returned as data. +- **ensure_management_controller**: now matches controller-level services only, and raises ``ValueError`` if several share the requested name. Previously a process-group service with the same name could be found and reconfigured. See Bug Fixes. +- **ParameterGroupConfigurationEntity**: ``parameter_sensitivities`` now validates its values rather than its keys and accepts ``None``, so parameter provider responses deserialize. See Bug Fixes. + +Wait timings, return types of existing functions and behaviour against supported NiFi 2.x servers are otherwise unchanged. + +**Deprecations** + +- **Python 3.9**: support is deprecated and will be removed in an upcoming release. Python 3.9 reached end of life in October 2025, and ``actions/setup-python`` publishes no Python 3.9 build for the Ubuntu 26.04 runner image, so CI is pinned to ``ubuntu-24.04`` for this release. 1.8.0 is still tested on Python 3.9; plan to move to Python 3.10 or later. + +**Supported Versions** + +- Bumped the supported and tested NiFi/Registry version from 2.10.0 to 2.12.0 and regenerated the NiFi and Registry API clients against the 2.12.0 OpenAPI specification. The change to the generated surface is additive: no API methods or models were removed or renamed. New operations include connector migration and backlog requests, processor backlog requests, and versioned flow rebase. +- The seeded test flows in the companion ``nipyapi-actions`` repository were updated to NiFi 2.12.0 component bundles. A flow saved on an older NiFi version reports an environmental "Component Bundle Changed" local modification when deployed to a newer one. + +**Bug Fixes** + +- **get_process_group**: a lookup by an ID that does not exist raised ``ValueError`` ("Unable to locate group ...") instead of returning ``None`` as its 404 handler intends, unlike ``get_processor`` and ``get_parameter_context``. It now returns ``None``; other API errors still raise ``ValueError``. The ``nipyapi.ci`` commands already handled ``None``, so their missing-group error is now ``Process group not found: ``. +- **ensure_management_controller**: the lookup by name also matched process-group services, so an existing process-group service with the same name could be reconfigured and enabled instead of a controller-level one being created. It now matches controller-level services only, and raises ``ValueError`` if several share the name. +- **Parameter provider models**: ``ParameterGroupConfigurationEntity.parameter_sensitivities`` validated its map keys (parameter names) against the ``SENSITIVE``/``NON_SENSITIVE`` enum instead of its values, so parameter provider fetch and apply responses could not be deserialized. Values are now validated, and ``None`` (staged on the first fetch of a new group) is accepted. + +**Parameter Providers and Contexts** + +- Added provider discovery, type lookup, property updates, fetch, apply, and combined fetch/apply helpers to ``nipyapi.parameters``. Apply retains staged sensitivity and ``synchronized`` choices unless overridden, and defaults unset choices to sensitive and synchronized, matching NiFi. Unknown parameter names in ``sensitivities`` raise ``ValueError``, and an apply with no synchronized groups logs a warning. The combined helper accepts the same override arguments. +- Added ordered context inheritance updates, process-group bound-context lookup, and local sensitive aliases to parameters in provider-created contexts. Connecting keeps an already inherited source in place unless a higher-precedence context shadows a mapped name, rejects non-sensitive source parameters, and keeps descriptions of overwritten aliases. New asynchronous helpers return the completed request DTO, including affected components. Existing context-update return types are unchanged. +- Standardized provider apply, context update and processor/controller verification on ``utils.wait_for_request``: completed requests are deleted, including failed ones, and an unfinished request is never cancelled implicitly. If a request fails and its cleanup also fails, the request failure is raised. See Behaviour Changes. +- Added ``canvas.list_all_management_controllers()`` and ``canvas.get_management_controller()`` for controller-level services without process-group-scoped results. + +**Maintenance** + +- Corrected the ``canvas.get_controller()`` docstring: ``bool_response=True`` returns ``False`` only when the API call fails (for example a missing ID); a name with no match returns ``None``. Behaviour is unchanged. +- Build targets no longer delete test certificates or coverage reports: ``make dist``, ``wheel``, ``sdist`` and ``install`` now clean only build output, and ``make check-dist`` and ``make test-dist`` reuse an existing build rather than rebuilding it. Certificates are removed only by the new ``make clean-certs`` or by ``make clean-all``. +- CI: the job that runs ``make test-dist`` now checks out full history and tags, so the test wheel carries the real version instead of the ``0.0.1.dev1+unknown`` that setuptools-scm falls back to in a shallow clone. ``make test-dist`` now fails on such a fallback version. The workflow actions move to their current Node 24 releases (checkout v7, setup-python v7, codecov v7, setup-buildx v4), and jobs are pinned to ``ubuntu-24.04``, because setup-python publishes no Python 3.9 build for the Ubuntu 26.04 image that ``ubuntu-latest`` is moving to. The workflow now limits its ``GITHUB_TOKEN`` to read-only repository contents. + +- Removed version guards and branches for NiFi releases older than 2.0, which nipyapi 1.x does not support. Parameter functions no longer make an extra ``/flow/about`` request on each call. ``canvas.list_all_processors``, ``canvas.list_all_controllers`` and ``nifi_registry.save_flow_ver`` now always use the 2.x API path they already took on supported servers. + +**Generated Clients** + +- **Configuration.client_side_validation**: New flag (default ``True``) on the NiFi and Registry ``Configuration`` objects. Setting it to ``False`` disables enum validation in generated models, for use against servers that return values the generated enums do not list yet. + 1.7.0 (2026-07-18) ------------------- diff --git a/docs/index.rst b/docs/index.rst index 52fd5919..326a98c9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Contents: profiles security extensions + parameters migration nipyapi-docs/api_reference contributing diff --git a/docs/nipyapi-docs/core_modules.rst b/docs/nipyapi-docs/core_modules.rst index 3868b5a7..8c2d35ab 100644 --- a/docs/nipyapi-docs/core_modules.rst +++ b/docs/nipyapi-docs/core_modules.rst @@ -10,6 +10,7 @@ They wrap the lower-level generated API clients with Pythonic interfaces. core_modules/ci core_modules/canvas core_modules/versioning + core_modules/nifi_registry core_modules/security core_modules/parameters core_modules/profiles diff --git a/docs/nipyapi-docs/core_modules/nifi_registry.rst b/docs/nipyapi-docs/core_modules/nifi_registry.rst new file mode 100644 index 00000000..4ddfaee6 --- /dev/null +++ b/docs/nipyapi-docs/core_modules/nifi_registry.rst @@ -0,0 +1,9 @@ +Nifi_Registry +============= + +Nifi_Registry functionality + +.. automodule:: nipyapi.nifi_registry + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/connectors_api.rst b/docs/nipyapi-docs/nifi_apis/connectors_api.rst new file mode 100644 index 00000000..1379b4bb --- /dev/null +++ b/docs/nipyapi-docs/nifi_apis/connectors_api.rst @@ -0,0 +1,4 @@ +.. automodule:: nipyapi.nifi.apis.connectors_api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nipyapi-docs/nifi_apis/index.rst b/docs/nipyapi-docs/nifi_apis/index.rst index 9994b4c7..3a439ac9 100644 --- a/docs/nipyapi-docs/nifi_apis/index.rst +++ b/docs/nipyapi-docs/nifi_apis/index.rst @@ -3,7 +3,7 @@ NiFi APIs Complete NiFi REST API client documentation. -This section documents all **28** NiFi API classes. Each API class provides methods for interacting with specific NiFi endpoints. Click any API to see its methods and their model parameters. +This section documents all **29** NiFi API classes. Each API class provides methods for interacting with specific NiFi endpoints. Click any API to see its methods and their model parameters. .. toctree:: :maxdepth: 1 @@ -11,6 +11,7 @@ This section documents all **28** NiFi API classes. Each API class provides meth access_api authentication_api connections_api + connectors_api controller_api controller_services_api counters_api diff --git a/docs/nipyapi-docs/nifi_models/models.rst b/docs/nipyapi-docs/nifi_models/models.rst index f05a9ee6..2afa0b3e 100644 --- a/docs/nipyapi-docs/nifi_models/models.rst +++ b/docs/nipyapi-docs/nifi_models/models.rst @@ -3,7 +3,7 @@ NiFi Models Complete model class reference for NiFi APIs. -This reference documents all **403** model classes used by NiFi APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here. +This reference documents all **451** model classes used by NiFi APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here. Model Type Patterns -------------------- @@ -118,6 +118,22 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: BacklogDTO + :members: + :show-inheritance: + +.. autoclass:: BacklogRequestDTO + :members: + :show-inheritance: + +.. autoclass:: BacklogRequestEntity + :members: + :show-inheritance: + +.. autoclass:: BacklogUpdateStepDTO + :members: + :show-inheritance: + .. autoclass:: BannerDTO :members: :show-inheritance: @@ -274,6 +290,30 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: ConfigurationStep + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepDependency + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepDependencyDTO + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepEntity + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepNamesEntity + :members: + :show-inheritance: + .. autoclass:: ConnectableComponent :members: :show-inheritance: @@ -326,6 +366,74 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: ConnectorActionDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorConfigurationDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorDefinition + :members: + :show-inheritance: + +.. autoclass:: ConnectorEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyAllowableValuesEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyDependency + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyDependencyDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyDescriptor + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyDescriptorDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyGroup + :members: + :show-inheritance: + +.. autoclass:: ConnectorRunStatusEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectorStatusDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorStatusSnapshotDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorTypesEntity + :members: + :show-inheritance: + +.. autoclass:: ConnectorValueReferenceDTO + :members: + :show-inheritance: + +.. autoclass:: ConnectorsEntity + :members: + :show-inheritance: + .. autoclass:: ContentViewerDTO :members: :show-inheritance: @@ -446,6 +554,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: CreateFlowBranchRequestEntity + :members: + :show-inheritance: + .. autoclass:: CurrentUserEntity :members: :show-inheritance: @@ -722,6 +834,30 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: MigrationPayloadDTO + :members: + :show-inheritance: + +.. autoclass:: MigrationPayloadEntity + :members: + :show-inheritance: + +.. autoclass:: MigrationRequestDTO + :members: + :show-inheritance: + +.. autoclass:: MigrationRequestEntity + :members: + :show-inheritance: + +.. autoclass:: MigrationRequestLocalSourceDTO + :members: + :show-inheritance: + +.. autoclass:: MigrationUpdateStepDTO + :members: + :show-inheritance: + .. autoclass:: MultiProcessorUseCase :members: :show-inheritance: @@ -754,6 +890,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: NodeConnectorStatusSnapshotDTO + :members: + :show-inheritance: + .. autoclass:: NodeCountersSnapshotDTO :members: :show-inheritance: @@ -1146,6 +1286,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: PropertyGroupConfigurationDTO + :members: + :show-inheritance: + .. autoclass:: PropertyHistoryDTO :members: :show-inheritance: @@ -1210,6 +1354,18 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: RebaseAnalysisEntity + :members: + :show-inheritance: + +.. autoclass:: RebaseChangeDTO + :members: + :show-inheritance: + +.. autoclass:: RebaseRequestEntity + :members: + :show-inheritance: + .. autoclass:: RegisteredFlow :members: :show-inheritance: @@ -1374,6 +1530,14 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: SecretDTO + :members: + :show-inheritance: + +.. autoclass:: SecretsEntity + :members: + :show-inheritance: + .. autoclass:: SnippetDTO :members: :show-inheritance: @@ -1414,6 +1578,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: StepDocumentationEntity + :members: + :show-inheritance: + .. autoclass:: StorageUsageDTO :members: :show-inheritance: @@ -1506,6 +1674,14 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VerifyConnectorConfigStepRequestDTO + :members: + :show-inheritance: + +.. autoclass:: VerifyConnectorConfigStepRequestEntity + :members: + :show-inheritance: + .. autoclass:: VersionControlComponentMappingEntity :members: :show-inheritance: @@ -1526,6 +1702,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VersionedComponentState + :members: + :show-inheritance: + .. autoclass:: VersionedConnection :members: :show-inheritance: @@ -1546,6 +1726,14 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VersionedFlowMigrationSourceDTO + :members: + :show-inheritance: + +.. autoclass:: VersionedFlowMigrationSourcesEntity + :members: + :show-inheritance: + .. autoclass:: VersionedFlowSnapshotEntity :members: :show-inheritance: @@ -1582,6 +1770,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VersionedNodeState + :members: + :show-inheritance: + .. autoclass:: VersionedParameter :members: :show-inheritance: diff --git a/docs/nipyapi-docs/registry_models/models.rst b/docs/nipyapi-docs/registry_models/models.rst index 438f206d..866c3b80 100644 --- a/docs/nipyapi-docs/registry_models/models.rst +++ b/docs/nipyapi-docs/registry_models/models.rst @@ -3,7 +3,7 @@ Registry Models Complete model class reference for Registry APIs. -This reference documents all **87** model classes used by Registry APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here. +This reference documents all **94** model classes used by Registry APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here. Model Type Patterns -------------------- @@ -90,10 +90,30 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: ConfigurationStep + :members: + :show-inheritance: + +.. autoclass:: ConfigurationStepDependency + :members: + :show-inheritance: + .. autoclass:: ConnectableComponent :members: :show-inheritance: +.. autoclass:: ConnectorProperty + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyDependency + :members: + :show-inheritance: + +.. autoclass:: ConnectorPropertyGroup + :members: + :show-inheritance: + .. autoclass:: ControllerServiceAPI :members: :show-inheritance: @@ -294,6 +314,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VersionedComponentState + :members: + :show-inheritance: + .. autoclass:: VersionedConnection :members: :show-inheritance: @@ -334,6 +358,10 @@ All Model Classes :members: :show-inheritance: +.. autoclass:: VersionedNodeState + :members: + :show-inheritance: + .. autoclass:: VersionedParameter :members: :show-inheritance: diff --git a/docs/parameters.rst b/docs/parameters.rst new file mode 100644 index 00000000..79ff5566 --- /dev/null +++ b/docs/parameters.rst @@ -0,0 +1,108 @@ +Parameter providers and contexts +================================ + +Provider workflow +----------------- + +Discover configured providers with ``list_all_parameter_providers()`` and +``get_parameter_provider()``. Discover installed provider types with +``list_all_parameter_provider_types()`` and ``get_parameter_provider_type()``. +Lookups return ``None``, a single model, or a list of matches. Mutating helpers +require exactly one provider. + +The provider operation helpers accept ``refresh=True`` by default: resolve the +input, get a fresh provider by ID, then perform the operation. Set +``refresh=False`` to use the resolved entity without that extra GET; NiFi rejects +it if its revision is stale. The inheritance, alias, and process-group binding +helpers always re-read their target, because the update is built from its current +state. Refreshing does not lock the object. + +.. code-block:: python + + from nipyapi import parameters + + provider = parameters.get_parameter_provider("my-provider", greedy=False) + fetched = parameters.fetch_parameter_provider(provider) + result = parameters.apply_parameter_provider( + provider, + group_names=["my-secrets"], + fetch_result=fetched, + ) + affected = result.referencing_components + +Fetching is a write: it stages source parameters in NiFi. Applying creates or +updates parameter contexts and may stop and restart affected components. +New parameters default to ``SENSITIVE``. Explicit per-parameter ``sensitivities`` +overrides take precedence over existing staged choices, which take precedence +over the default. The staged ``synchronized`` setting is also kept unless +``synchronized`` is passed; unset groups default to synchronized, because NiFi +only creates or updates contexts for synchronized groups. Both apply and context-inheritance operations wait for completion +and return the completed request DTO. They delete the server-side request only +once completion is observed, whether it succeeded or failed. A terminal request +failure is raised with NiFi's diagnostic; if deletion also fails, that failure +remains primary and a cleanup warning is logged. Deletion errors otherwise propagate. +Timeouts, polling errors and interruptions do not delete an unfinished request: +early deletion would cancel subsequent server-side steps. NiFi may continue the +operation after the client stops waiting; interruption is not a rollback. + +For a combined operation, use ``fetch_and_apply_parameter_provider(provider)``. +The CLI form is ``nipyapi parameters fetch_and_apply_parameter_provider ``; a UUID is looked up by ID automatically. +It rejects missing or empty selected groups by default. Scope provider properties +before fetching. + +Per-parameter ``sensitivities`` overrides are keyed by parameter name and apply in +every selected group; a name that matches no selected parameter raises +``ValueError`` rather than being ignored. Both apply helpers accept +``sensitivities`` and ``synchronized``. If no selected group is synchronized, NiFi +completes the request without changing anything, and nipyapi logs a warning. + +Sensitive data and diagnostics +------------------------------ + +NiFi masks sensitive parameter and provider-property values in returned models. +Keep secrets marked sensitive: values deliberately applied as ``NON_SENSITIVE`` +are readable from NiFi. + +The helpers preserve NiFi's diagnostics. Failed asynchronous operations raise +``ValueError`` with the server's ``failure_reason``. REST failures propagate the +original ``ApiException``, including its status, reason, headers, and response +body. Fetch HTTP 500 errors also log a configuration/source-access/scope hint. +The generated clients retain their existing response-body DEBUG logging. + +Context inheritance and aliases +------------------------------- + +``get_process_group_parameter_context(pg)`` reads the group's current binding; +it returns ``None`` for an unbound group. ``set_inherited_parameter_contexts`` +prepends contexts in precedence order or replaces the inheritance list. + +.. code-block:: python + + result = parameters.connect_parameter_provider_group( + target="my-process-group", + group_name="my-secrets", + mappings={"Local API Secret": "API_KEY"}, + greedy=False, + ) + +This creates a local sensitive parameter whose value is ``#{API_KEY}`` and inherits +the named context, in one context update. The first inherited context defining a +name takes precedence, and the alias resolves against it, so a newly inherited +context is placed first. An already inherited context keeps its position unless a +higher-precedence context defines a mapped source name; that raises +``ValueError``, and the order can be set explicitly with +``set_inherited_parameter_contexts(..., mode="replace")``. It preserves other +local parameters +and inherited contexts. The target can also be a context entity, process-group +entity, or ID. Ambiguous names and unbound process groups are rejected. Existing +sensitive locals are overwritten with their descriptions kept. Non-sensitive +source parameters are rejected, because NiFi leaves a sensitive alias to them +unresolved. Existing non-sensitive locals are rejected +because NiFi does not allow changing their sensitivity in place. Deleting and +recreating such a parameter is a separate operator-managed change, not an atomic +alias update. + +The existing ``update_parameter_context`` and ``upsert_parameter_to_context`` +functions continue returning the updated context, not the request DTO. + +See :doc:`nipyapi-docs/core_modules/parameters` for the API reference. diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index a8dec3be..01b88b4c 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -55,6 +55,8 @@ "delete_connection", "get_component_connections", "create_controller", + "list_all_management_controllers", + "get_management_controller", "create_management_controller", "ensure_management_controller", "list_all_controllers", @@ -197,14 +199,14 @@ def get_process_group(identifier, identifier_type="name", greedy=True): """ assert isinstance(identifier, str) assert identifier_type in ["name", "id"] - with nipyapi.utils.rest_exceptions(): - 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, greedy=greedy) + # exception_handler maps 404 to None and other API errors to ValueError. + 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, greedy=greedy) return out @@ -365,22 +367,10 @@ def list_all_processors(pg_id="root"): """ assert isinstance(pg_id, str), "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 - ) - return targets.processors - # Handle older NiFi instances - out = [] - # list of child process groups - pg_ids = [x.id for x in list_all_process_groups(pg_id)] - # process target list - for this_pg_id in pg_ids: - procs = nipyapi.nifi.ProcessGroupsApi().get_processors(this_pg_id) - if procs.processors: - out += procs.processors - return out + targets = nipyapi.nifi.ProcessGroupsApi().get_processors( + id=pg_id, include_descendant_groups=True + ) + return targets.processors def schedule_process_group(process_group_id, scheduled, greedy=True, identifier_type="auto"): @@ -2151,6 +2141,50 @@ def create_controller(parent_pg, controller, name=None): ) +def list_all_management_controllers(): + """List controller-level services, excluding process-group services. + + Returns: + list[ControllerServiceEntity]: Management controller services. + """ + return nipyapi.nifi.FlowApi().get_controller_services_from_controller().controller_services + + +def get_management_controller(identifier, identifier_type="name", bool_response=False, greedy=True): + """Find controller-level services by name or ID. + + Args: + identifier (str): Name or ID to match. + identifier_type (str): "name" or "id". + bool_response (bool): Return False instead of raising when the API call fails, + matching get_controller. A name with no match returns None. + greedy (bool): Use substring matching instead of exact matching. + + Returns: + ControllerServiceEntity or list or None or False: Matching management + services. Process-group-scoped services are not returned. + + Raises: + ValueError: If the API request fails and bool_response is False. + """ + assert isinstance(identifier, str) + assert identifier_type in ["name", "id"] + try: + if identifier_type == "id": + result = nipyapi.nifi.ControllerServicesApi().get_controller_service(identifier) + if result.component.parent_group_id is not None: + result = None + else: + result = nipyapi.utils.filter_obj( + list_all_management_controllers(), identifier, identifier_type, greedy=greedy + ) + except nipyapi.nifi.rest.ApiException as exc: + if bool_response: + return False + raise ValueError(exc.body) from exc + return result + + def create_management_controller(controller, name=None): """ Creates a new controller-level (management) Controller Service of the given @@ -2201,7 +2235,8 @@ def ensure_management_controller(name, controller_type, properties=None, enable= configured, and (optionally) enabled. Idempotent by name. Composes the existing controller-service functions: finds an existing - service by name, creates it via :func:`create_management_controller` if + controller-level service by exact name (process-group services are ignored), + creates it via :func:`create_management_controller` if absent, applies ``properties`` via :func:`update_controller`, and enables it via :func:`schedule_controller`. @@ -2216,13 +2251,16 @@ def ensure_management_controller(name, controller_type, properties=None, enable= :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The ensured controller service Raises: - ValueError: If the controller service type is not available on this NiFi. + ValueError: If the controller service type is not available on this NiFi, + or several controller-level services have the name. """ assert isinstance(name, str) assert isinstance(controller_type, str) assert properties is None or isinstance(properties, dict) - controller = get_controller(name, identifier_type="name", bool_response=True, greedy=False) + controller = get_management_controller(name, bool_response=True, greedy=False) + if isinstance(controller, list): + raise ValueError(f"Several controller-level services are named '{name}'") if not controller: cs_type = get_controller_type(controller_type, identifier_type="name", greedy=False) if cs_type is None: @@ -2288,29 +2326,12 @@ def list_all_controllers( # pylint: disable=too-many-arguments,too-many-positio ) pg_id = process_group.id handle = nipyapi.nifi.FlowApi() - # Testing shows that descendant doesn't work on NiFi-1.1.2 - # 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: - new_conts = handle.get_controller_services_from_group( - pg.id, include_ancestor_groups=include_ancestors - ).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, - include_ancestor_groups=include_ancestors, - ).controller_services + # The server removes duplicates across inherited and descendant groups. + out = handle.get_controller_services_from_group( + pg_id, + include_descendant_groups=descendants, + include_ancestor_groups=include_ancestors, + ).controller_services if include_reporting_tasks: mgmt_handle = nipyapi.nifi.FlowApi() out += mgmt_handle.get_controller_services_from_controller().controller_services @@ -2637,13 +2658,15 @@ def get_controller( Args: identifier (str): ID or Name of a Controller to find identifier_type (str): 'id' or 'name', defaults to name - bool_response (bool): If True, will return False if the Controller is - not found - useful when testing for deletion completion + bool_response (bool): If True, return False instead of raising when the API + call fails, such as an ID that no longer exists; useful when testing for + deletion completion. A name with no match still returns None. include_reporting_tasks (bool): If True, will include Reporting Tasks in the search greedy (bool): Whether to exact match (False) or partial match (True) Returns: - ControllerServiceEntity or None/False depending on bool_response + ControllerServiceEntity or list or None or False: False only when + bool_response is True and the API call fails. """ assert isinstance(identifier, str) @@ -3146,7 +3169,8 @@ def _run_verification_request(component_id, body, submit_func, get_func, delete_ Run an async verification request workflow: submit, poll, cleanup. This helper consolidates the common pattern used by verify_controller - and verify_processor to avoid code duplication. + and verify_processor to avoid code duplication. Polling and completed-request + deletion use utils.wait_for_request; interrupted waits do not cancel requests. Args: component_id: ID of the component being verified @@ -3158,28 +3182,14 @@ def _run_verification_request(component_id, body, submit_func, get_func, delete_ Returns: list[ConfigVerificationResultDTO]: Verification results """ - request_id = None - - try: - with nipyapi.utils.rest_exceptions(): - response = submit_func(body=body, id=component_id) - request_id = response.request.request_id - - def _check_complete(): - status = get_func(id=component_id, request_id=request_id) - if status.request.complete: - return status - return False - - status = nipyapi.utils.wait_to_complete(_check_complete) - return status.request.results or [] - - finally: - if request_id: - try: - delete_func(id=component_id, request_id=request_id) - except Exception: # pylint: disable=broad-except - log.warning("Failed to cleanup verification request %s", request_id) + with nipyapi.utils.rest_exceptions(): + response = submit_func(body=body, id=component_id) + request_id = response.request.request_id + request = nipyapi.utils.wait_for_request( + lambda: get_func(id=component_id, request_id=request_id), + lambda: delete_func(id=component_id, request_id=request_id), + ) + return request.results or [] def verify_controller( @@ -3191,7 +3201,8 @@ def verify_controller( Validates that all required properties are set and property values meet their defined constraints. Does NOT test actual connectivity or credentials. Handles the async verification workflow: submit request, poll until - complete, cleanup. + complete, then delete the completed request. Timeout or polling interruption + does not cancel the server-side operation. The controller service must be DISABLED before verification. @@ -3211,8 +3222,8 @@ def verify_controller( Raises: TypeError: If controller is not a string or ControllerServiceEntity. ValueError: Controller not found, multiple matches found, or is - currently enabled. - ApiException: NiFi API errors + currently enabled, or the request fails or times out. + ApiException: NiFi API errors, including completed-request deletion errors. Example:: @@ -3264,7 +3275,8 @@ def verify_processor( Validates that all required properties are set and property values meet their defined constraints. Does NOT test actual connectivity or external service availability. Handles the async verification workflow: submit - request, poll until complete, cleanup. + request, poll until complete, then delete the completed request. Timeout or + polling interruption does not cancel the server-side operation. The processor must be STOPPED before verification. @@ -3284,8 +3296,8 @@ def verify_processor( Raises: TypeError: If processor is not a string or ProcessorEntity. ValueError: Processor not found, multiple matches found, or is - currently running. - ApiException: NiFi API errors + currently running, or the request fails or times out. + ApiException: NiFi API errors, including completed-request deletion errors. Example:: diff --git a/nipyapi/config.py b/nipyapi/config.py index 029abcdc..e1e5f9aa 100644 --- a/nipyapi/config.py +++ b/nipyapi/config.py @@ -71,6 +71,11 @@ "ControllerServiceEntity": {"id": ["id"], "name": ["component", "name"]}, "PortEntity": {"id": ["id"], "name": ["status", "name"]}, "ParameterContextEntity": {"id": ["id"], "name": ["component", "name"]}, + "ParameterProviderEntity": { + "id": ["id"], + "name": ["component", "name"], + "type": ["component", "type"], + }, "ReportingTaskEntity": {"id": ["id"], "name": ["component", "name"]}, # Git-based Flow Registry types (GitHub, GitLab, Bitbucket, Azure DevOps) "FlowRegistryBucketEntity": {"id": ["id"], "name": ["bucket", "name"]}, diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index 3da56ab9..0fc23990 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -32,6 +32,10 @@ from .models.attribute_dto import AttributeDTO from .models.authentication_configuration_dto import AuthenticationConfigurationDTO from .models.authentication_configuration_entity import AuthenticationConfigurationEntity +from .models.backlog_dto import BacklogDTO +from .models.backlog_request_dto import BacklogRequestDTO +from .models.backlog_request_entity import BacklogRequestEntity +from .models.backlog_update_step_dto import BacklogUpdateStepDTO from .models.banner_dto import BannerDTO from .models.banner_entity import BannerEntity from .models.batch_settings_dto import BatchSettingsDTO @@ -207,6 +211,12 @@ from .models.listing_request_dto import ListingRequestDTO from .models.listing_request_entity import ListingRequestEntity from .models.long_parameter import LongParameter +from .models.migration_payload_dto import MigrationPayloadDTO +from .models.migration_payload_entity import MigrationPayloadEntity +from .models.migration_request_dto import MigrationRequestDTO +from .models.migration_request_entity import MigrationRequestEntity +from .models.migration_request_local_source_dto import MigrationRequestLocalSourceDTO +from .models.migration_update_step_dto import MigrationUpdateStepDTO from .models.multi_processor_use_case import MultiProcessorUseCase from .models.nar_coordinate_dto import NarCoordinateDTO from .models.nar_details_entity import NarDetailsEntity @@ -331,6 +341,9 @@ from .models.provenance_search_value_dto import ProvenanceSearchValueDTO from .models.provenance_searchable_field_dto import ProvenanceSearchableFieldDTO from .models.queue_size_dto import QueueSizeDTO +from .models.rebase_analysis_entity import RebaseAnalysisEntity +from .models.rebase_change_dto import RebaseChangeDTO +from .models.rebase_request_entity import RebaseRequestEntity from .models.registered_flow import RegisteredFlow from .models.registered_flow_snapshot import RegisteredFlowSnapshot from .models.registered_flow_snapshot_metadata import RegisteredFlowSnapshotMetadata @@ -421,6 +434,8 @@ from .models.versioned_flow_coordinates import VersionedFlowCoordinates from .models.versioned_flow_dto import VersionedFlowDTO from .models.versioned_flow_entity import VersionedFlowEntity +from .models.versioned_flow_migration_source_dto import VersionedFlowMigrationSourceDTO +from .models.versioned_flow_migration_sources_entity import VersionedFlowMigrationSourcesEntity from .models.versioned_flow_snapshot_entity import VersionedFlowSnapshotEntity from .models.versioned_flow_snapshot_metadata_entity import VersionedFlowSnapshotMetadataEntity from .models.versioned_flow_snapshot_metadata_set_entity import VersionedFlowSnapshotMetadataSetEntity diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 9ebd6bd0..5830c98f 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 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 79678980..a901670c 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/authentication_api.py b/nipyapi/nifi/apis/authentication_api.py index fc0ecd68..3e3a0270 100644 --- a/nipyapi/nifi/apis/authentication_api.py +++ b/nipyapi/nifi/apis/authentication_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 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 d5da9e01..9fa02526 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/connectors_api.py b/nipyapi/nifi/apis/connectors_api.py index 902ac032..2c239abc 100644 --- a/nipyapi/nifi/apis/connectors_api.py +++ b/nipyapi/nifi/apis/connectors_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -694,6 +694,209 @@ def create_connector_with_http_info(self, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_migration_payload(self, body, id, **kwargs): + """ + Uploads a flow snapshot payload for a later Connector migration request. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_migration_payload_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The migration payload snapshot (required) + id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.MigrationPayloadEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_migration_payload_with_http_info(body, id, **kwargs) + else: + (data) = self.create_migration_payload_with_http_info(body, id, **kwargs) + return data + + def create_migration_payload_with_http_info(self, body, id, **kwargs): + """ + Uploads a flow snapshot payload for a later Connector migration request. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_migration_payload()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.object`): + The migration payload snapshot (required) + id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.MigrationPayloadEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['body', 'id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_migration_payload" % 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_migration_payload`") + # 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_migration_payload`") + + + + 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/octet-stream']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/migration-payloads', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MigrationPayloadEntity', + auth_settings=auth_settings, + _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_migration_request(self, id, **kwargs): + """ + Creates a Connector migration request. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``create_migration_request_with_http_info()`` method instead. + + Args: + id (str): (required) + body (:class:`~nipyapi.nifi.models.MigrationRequestEntity`): + + Returns: + :class:`~nipyapi.nifi.models.MigrationRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_migration_request_with_http_info(id, **kwargs) + else: + (data) = self.create_migration_request_with_http_info(id, **kwargs) + return data + + def create_migration_request_with_http_info(self, id, **kwargs): + """ + Creates a Connector migration request. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``create_migration_request()`` method instead. + + Args: + id (str): (required) + body (:class:`~nipyapi.nifi.models.MigrationRequestEntity`): + + Returns: + tuple: (:class:`~nipyapi.nifi.models.MigrationRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'body'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_migration_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_migration_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 + 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 = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/migration-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MigrationRequestEntity', + auth_settings=auth_settings, + _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_purge_request(self, id, **kwargs): """ Creates a request to purge the FlowFiles for this connector. @@ -1023,63 +1226,55 @@ def delete_connector_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def discard_connector_update(self, id, **kwargs): + def delete_connector_backlog_request(self, id, request_id, **kwargs): """ - Discards the working configuration of a connector. + Deletes the Backlog Request with the given ID. - This will discard any pending configuration changes for the connector and revert to the last applied configuration. + Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``discard_connector_update_with_http_info()`` method instead. + ``delete_connector_backlog_request_with_http_info()`` method instead. Args: id (str): The connector id. (required) - version (:class:`~nipyapi.nifi.models.LongParameter`): - The revision is used to verify the client is working with the latest version of the flow. - client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - disconnected_node_acknowledged (bool): - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + request_id (str): + The ID of the Backlog Request (required) Returns: - :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.discard_connector_update_with_http_info(id, **kwargs) + return self.delete_connector_backlog_request_with_http_info(id, request_id, **kwargs) else: - (data) = self.discard_connector_update_with_http_info(id, **kwargs) + (data) = self.delete_connector_backlog_request_with_http_info(id, request_id, **kwargs) return data - def discard_connector_update_with_http_info(self, id, **kwargs): + def delete_connector_backlog_request_with_http_info(self, id, request_id, **kwargs): """ - Discards the working configuration of a connector. + Deletes the Backlog Request with the given ID. - This will discard any pending configuration changes for the connector and revert to the last applied configuration. + Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``discard_connector_update()`` method instead. + For just the response data, use the corresponding ``delete_connector_backlog_request()`` method instead. Args: id (str): The connector id. (required) - version (:class:`~nipyapi.nifi.models.LongParameter`): - The revision is used to verify the client is working with the latest version of the flow. - client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - disconnected_node_acknowledged (bool): - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + request_id (str): + The ID of the Backlog Request (required) Returns: - tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params = ['id', 'request_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1089,31 +1284,28 @@ def discard_connector_update_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method discard_connector_update" % key + " to method delete_connector_backlog_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 `discard_connector_update`") + raise ValueError("Missing the required parameter `id` when calling `delete_connector_backlog_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_connector_backlog_request`") - - collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] + if 'request_id' in params: + path_params['requestId'] = params['request_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 = {} @@ -1128,77 +1320,59 @@ def discard_connector_update_with_http_info(self, id, **kwargs): # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/working-configuration', 'DELETE', + return self.api_client.call_api('/connectors/{id}/backlog-requests/{requestId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConnectorEntity', + response_type='BacklogRequestEntity', auth_settings=auth_settings, _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 end_troubleshooting(self, id, **kwargs): + def delete_migration_request(self, id, request_id, **kwargs): """ - Transitions a Connector out of Troubleshooting mode. - - Ends Troubleshooting mode for the Connector, restoring the authoritative flow. All components in the managed flow must be stopped and disabled, and the managed flow must have no active tasks. - + Deletes the Connector migration request with the given ID. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``end_troubleshooting_with_http_info()`` method instead. + ``delete_migration_request_with_http_info()`` method instead. Args: - id (str): - The connector id. (required) - version (:class:`~nipyapi.nifi.models.LongParameter`): - The revision is used to verify the client is working with the latest version of the flow. - client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - disconnected_node_acknowledged (bool): - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + id (str): (required) + request_id (str): (required) Returns: - :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + :class:`~nipyapi.nifi.models.MigrationRequestEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.end_troubleshooting_with_http_info(id, **kwargs) + return self.delete_migration_request_with_http_info(id, request_id, **kwargs) else: - (data) = self.end_troubleshooting_with_http_info(id, **kwargs) + (data) = self.delete_migration_request_with_http_info(id, request_id, **kwargs) return data - def end_troubleshooting_with_http_info(self, id, **kwargs): + def delete_migration_request_with_http_info(self, id, request_id, **kwargs): """ - Transitions a Connector out of Troubleshooting mode. - - Ends Troubleshooting mode for the Connector, restoring the authoritative flow. All components in the managed flow must be stopped and disabled, and the managed flow must have no active tasks. - + Deletes the Connector migration request with the given ID. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``end_troubleshooting()`` method instead. + For just the response data, use the corresponding ``delete_migration_request()`` method instead. Args: - id (str): - The connector id. (required) - version (:class:`~nipyapi.nifi.models.LongParameter`): - The revision is used to verify the client is working with the latest version of the flow. - client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. - disconnected_node_acknowledged (bool): - Acknowledges that this node is disconnected to allow for mutable requests to proceed. + id (str): (required) + request_id (str): (required) Returns: - tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.MigrationRequestEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params = ['id', 'request_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1208,26 +1382,261 @@ def end_troubleshooting_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method end_troubleshooting" % key + " to method delete_migration_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 `end_troubleshooting`") + raise ValueError("Missing the required parameter `id` when calling `delete_migration_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_migration_request`") - - collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] + if 'request_id' in params: + path_params['requestId'] = params['request_id'] query_params = [] - if 'version' in 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/migration-requests/{requestId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MigrationRequestEntity', + auth_settings=auth_settings, + _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 discard_connector_update(self, id, **kwargs): + """ + Discards the working configuration of a connector. + + This will discard any pending configuration changes for the connector and revert to the last applied configuration. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``discard_connector_update_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The revision is used to verify the client is working with the latest version of the flow. + client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): + If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.discard_connector_update_with_http_info(id, **kwargs) + else: + (data) = self.discard_connector_update_with_http_info(id, **kwargs) + return data + + def discard_connector_update_with_http_info(self, id, **kwargs): + """ + Discards the working configuration of a connector. + + This will discard any pending configuration changes for the connector and revert to the last applied configuration. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``discard_connector_update()`` method instead. + + Args: + id (str): + The connector id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The revision is used to verify the client is working with the latest version of the flow. + client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): + If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method discard_connector_update" % 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 `discard_connector_update`") + + + + + + 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/working-configuration', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectorEntity', + auth_settings=auth_settings, + _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 end_troubleshooting(self, id, **kwargs): + """ + Transitions a Connector out of Troubleshooting mode. + + Ends Troubleshooting mode for the Connector, restoring the authoritative flow. All components in the managed flow must be stopped and disabled, and the managed flow must have no active tasks. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``end_troubleshooting_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The revision is used to verify the client is working with the latest version of the flow. + client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): + If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.end_troubleshooting_with_http_info(id, **kwargs) + else: + (data) = self.end_troubleshooting_with_http_info(id, **kwargs) + return data + + def end_troubleshooting_with_http_info(self, id, **kwargs): + """ + Transitions a Connector out of Troubleshooting mode. + + Ends Troubleshooting mode for the Connector, restoring the authoritative flow. All components in the managed flow must be stopped and disabled, and the managed flow must have no active tasks. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``end_troubleshooting()`` method instead. + + Args: + id (str): + The connector id. (required) + version (:class:`~nipyapi.nifi.models.LongParameter`): + The revision is used to verify the client is working with the latest version of the flow. + client_id (:class:`~nipyapi.nifi.models.ClientIdParameter`): + If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method end_troubleshooting" % 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 `end_troubleshooting`") + + + + + + 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'])) @@ -1651,16 +2060,512 @@ def get_configuration_step_verification_request_with_http_info(self, id, configu - + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + if 'configuration_step_name' in params: + path_params['configurationStepName'] = params['configuration_step_name'] + 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}/verify-config/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VerifyConnectorConfigStepRequestEntity', + auth_settings=auth_settings, + _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_connector(self, id, **kwargs): + """ + Gets a connector. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_with_http_info(id, **kwargs) + else: + (data) = self.get_connector_with_http_info(id, **kwargs) + return data + + def get_connector_with_http_info(self, id, **kwargs): + """ + Gets a connector. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector" % 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_connector`") + + + 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectorEntity', + auth_settings=auth_settings, + _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_connector_backlog_request(self, id, request_id, **kwargs): + """ + Returns the Backlog Request with the given ID. + + Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /connectors/{id}/backlog-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 the backlog once the request is complete. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_backlog_request_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_backlog_request_with_http_info(id, request_id, **kwargs) + else: + (data) = self.get_connector_backlog_request_with_http_info(id, request_id, **kwargs) + return data + + def get_connector_backlog_request_with_http_info(self, id, request_id, **kwargs): + """ + Returns the Backlog Request with the given ID. + + Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /connectors/{id}/backlog-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 the backlog once the request is complete. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector_backlog_request()`` method instead. + + Args: + id (str): + The connector id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'request_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector_backlog_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_connector_backlog_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 `get_connector_backlog_request`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/backlog-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BacklogRequestEntity', + auth_settings=auth_settings, + _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_connector_configuration_step(self, id, configuration_step_name, **kwargs): + """ + Gets a specific configuration step by name for a connector. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_configuration_step_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + configuration_step_name (str): + The configuration step name. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationStepEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_configuration_step_with_http_info(id, configuration_step_name, **kwargs) + else: + (data) = self.get_connector_configuration_step_with_http_info(id, configuration_step_name, **kwargs) + return data + + def get_connector_configuration_step_with_http_info(self, id, configuration_step_name, **kwargs): + """ + Gets a specific configuration step by name for a connector. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector_configuration_step()`` method instead. + + Args: + id (str): + The connector id. (required) + configuration_step_name (str): + The configuration step name. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationStepEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'configuration_step_name'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector_configuration_step" % 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_connector_configuration_step`") + # verify the required parameter 'configuration_step_name' is set + if ('configuration_step_name' not in params) or (params['configuration_step_name'] is None): + raise ValueError("Missing the required parameter `configuration_step_name` when calling `get_connector_configuration_step`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + if 'configuration_step_name' in params: + path_params['configurationStepName'] = params['configuration_step_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConfigurationStepEntity', + auth_settings=auth_settings, + _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_connector_configuration_steps(self, id, **kwargs): + """ + Gets all configuration step names for a connector. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_configuration_steps_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + :class:`~nipyapi.nifi.models.ConfigurationStepNamesEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_configuration_steps_with_http_info(id, **kwargs) + else: + (data) = self.get_connector_configuration_steps_with_http_info(id, **kwargs) + return data + + def get_connector_configuration_steps_with_http_info(self, id, **kwargs): + """ + Gets all configuration step names for a connector. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector_configuration_steps()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.ConfigurationStepNamesEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector_configuration_steps" % 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_connector_configuration_steps`") + + + 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/configuration-steps', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConfigurationStepNamesEntity', + auth_settings=auth_settings, + _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_connector_connection_status_history(self, id, connection_id, **kwargs): + """ + Gets the status history for a connection within a connector. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_connection_status_history_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + connection_id (str): + The connection id. (required) + + Returns: + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_connection_status_history_with_http_info(id, connection_id, **kwargs) + else: + (data) = self.get_connector_connection_status_history_with_http_info(id, connection_id, **kwargs) + return data + + def get_connector_connection_status_history_with_http_info(self, id, connection_id, **kwargs): + """ + Gets the status history for a connection within a connector. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector_connection_status_history()`` method instead. + + Args: + id (str): + The connector id. (required) + connection_id (str): + The connection id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'connection_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector_connection_status_history" % 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_connector_connection_status_history`") + # verify the required parameter 'connection_id' is set + if ('connection_id' not in params) or (params['connection_id'] is None): + raise ValueError("Missing the required parameter `connection_id` when calling `get_connector_connection_status_history`") + + + collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] - if 'configuration_step_name' in params: - path_params['configurationStepName'] = params['configuration_step_name'] - if 'request_id' in params: - path_params['requestId'] = params['request_id'] + if 'connection_id' in params: + path_params['connectionId'] = params['connection_id'] query_params = [] @@ -1677,59 +2582,71 @@ def get_configuration_step_verification_request_with_http_info(self, id, configu # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}/verify-config/{requestId}', 'GET', + return self.api_client.call_api('/connectors/{id}/connections/{connectionId}/status/history', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='VerifyConnectorConfigStepRequestEntity', + response_type='StatusHistoryEntity', auth_settings=auth_settings, _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_connector(self, id, **kwargs): + def get_connector_controller_service(self, id, controller_service_id, **kwargs): """ - Gets a connector. + Gets a controller service within a connector. + + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. + This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``get_connector_with_http_info()`` method instead. + ``get_connector_controller_service_with_http_info()`` method instead. Args: id (str): The connector id. (required) + controller_service_id (str): + The controller service id. (required) + ui_only (bool): Returns: - :class:`~nipyapi.nifi.models.ConnectorEntity`: The response data. + :class:`~nipyapi.nifi.models.ControllerServiceEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connector_with_http_info(id, **kwargs) + return self.get_connector_controller_service_with_http_info(id, controller_service_id, **kwargs) else: - (data) = self.get_connector_with_http_info(id, **kwargs) + (data) = self.get_connector_controller_service_with_http_info(id, controller_service_id, **kwargs) return data - def get_connector_with_http_info(self, id, **kwargs): + def get_connector_controller_service_with_http_info(self, id, controller_service_id, **kwargs): """ - Gets a connector. + Gets a controller service within a connector. + + If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. + This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``get_connector()`` method instead. + For just the response data, use the corresponding ``get_connector_controller_service()`` method instead. Args: id (str): The connector id. (required) + controller_service_id (str): + The controller service id. (required) + ui_only (bool): Returns: - tuple: (:class:`~nipyapi.nifi.models.ConnectorEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.ControllerServiceEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] + all_params = ['id', 'controller_service_id', 'ui_only'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1739,22 +2656,31 @@ def get_connector_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connector" % key + " to method get_connector_controller_service" % 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_connector`") + raise ValueError("Missing the required parameter `id` when calling `get_connector_controller_service`") + # verify the required parameter 'controller_service_id' is set + if ('controller_service_id' not in params) or (params['controller_service_id'] is None): + raise ValueError("Missing the required parameter `controller_service_id` when calling `get_connector_controller_service`") + + collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] + if 'controller_service_id' in params: + path_params['controllerServiceId'] = params['controller_service_id'] query_params = [] + if 'ui_only' in params: + query_params.append(('uiOnly', params['ui_only'])) header_params = {} @@ -1769,63 +2695,63 @@ def get_connector_with_http_info(self, id, **kwargs): # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}', 'GET', + return self.api_client.call_api('/connectors/{id}/controller-services/{controllerServiceId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConnectorEntity', + response_type='ControllerServiceEntity', auth_settings=auth_settings, _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_connector_configuration_step(self, id, configuration_step_name, **kwargs): + def get_connector_controller_service_state(self, id, controller_service_id, **kwargs): """ - Gets a specific configuration step by name for a connector. + Gets the state for a controller service within a connector. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``get_connector_configuration_step_with_http_info()`` method instead. + ``get_connector_controller_service_state_with_http_info()`` method instead. Args: id (str): The connector id. (required) - configuration_step_name (str): - The configuration step name. (required) + controller_service_id (str): + The controller service id. (required) Returns: - :class:`~nipyapi.nifi.models.ConfigurationStepEntity`: The response data. + :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connector_configuration_step_with_http_info(id, configuration_step_name, **kwargs) + return self.get_connector_controller_service_state_with_http_info(id, controller_service_id, **kwargs) else: - (data) = self.get_connector_configuration_step_with_http_info(id, configuration_step_name, **kwargs) + (data) = self.get_connector_controller_service_state_with_http_info(id, controller_service_id, **kwargs) return data - def get_connector_configuration_step_with_http_info(self, id, configuration_step_name, **kwargs): + def get_connector_controller_service_state_with_http_info(self, id, controller_service_id, **kwargs): """ - Gets a specific configuration step by name for a connector. + Gets the state for a controller service within a connector. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``get_connector_configuration_step()`` method instead. + For just the response data, use the corresponding ``get_connector_controller_service_state()`` method instead. Args: id (str): The connector id. (required) - configuration_step_name (str): - The configuration step name. (required) + controller_service_id (str): + The controller service id. (required) Returns: - tuple: (:class:`~nipyapi.nifi.models.ConfigurationStepEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'configuration_step_name'] + all_params = ['id', 'controller_service_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1835,16 +2761,16 @@ def get_connector_configuration_step_with_http_info(self, id, configuration_step if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connector_configuration_step" % key + " to method get_connector_controller_service_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_connector_configuration_step`") - # verify the required parameter 'configuration_step_name' is set - if ('configuration_step_name' not in params) or (params['configuration_step_name'] is None): - raise ValueError("Missing the required parameter `configuration_step_name` when calling `get_connector_configuration_step`") + raise ValueError("Missing the required parameter `id` when calling `get_connector_controller_service_state`") + # verify the required parameter 'controller_service_id' is set + if ('controller_service_id' not in params) or (params['controller_service_id'] is None): + raise ValueError("Missing the required parameter `controller_service_id` when calling `get_connector_controller_service_state`") @@ -1853,8 +2779,8 @@ def get_connector_configuration_step_with_http_info(self, id, configuration_step path_params = {} if 'id' in params: path_params['id'] = params['id'] - if 'configuration_step_name' in params: - path_params['configurationStepName'] = params['configuration_step_name'] + if 'controller_service_id' in params: + path_params['controllerServiceId'] = params['controller_service_id'] query_params = [] @@ -1871,59 +2797,63 @@ def get_connector_configuration_step_with_http_info(self, id, configuration_step # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}', 'GET', + return self.api_client.call_api('/connectors/{id}/controller-services/{controllerServiceId}/state', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConfigurationStepEntity', + response_type='ComponentStateEntity', auth_settings=auth_settings, _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_connector_configuration_steps(self, id, **kwargs): + def get_connector_process_group_status_history(self, id, process_group_id, **kwargs): """ - Gets all configuration step names for a connector. + Gets the status history for a process group within a connector. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``get_connector_configuration_steps_with_http_info()`` method instead. + ``get_connector_process_group_status_history_with_http_info()`` method instead. Args: id (str): The connector id. (required) + process_group_id (str): + The process group id. (required) Returns: - :class:`~nipyapi.nifi.models.ConfigurationStepNamesEntity`: The response data. + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connector_configuration_steps_with_http_info(id, **kwargs) + return self.get_connector_process_group_status_history_with_http_info(id, process_group_id, **kwargs) else: - (data) = self.get_connector_configuration_steps_with_http_info(id, **kwargs) + (data) = self.get_connector_process_group_status_history_with_http_info(id, process_group_id, **kwargs) return data - def get_connector_configuration_steps_with_http_info(self, id, **kwargs): + def get_connector_process_group_status_history_with_http_info(self, id, process_group_id, **kwargs): """ - Gets all configuration step names for a connector. + Gets the status history for a process group within a connector. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``get_connector_configuration_steps()`` method instead. + For just the response data, use the corresponding ``get_connector_process_group_status_history()`` method instead. Args: id (str): The connector id. (required) + process_group_id (str): + The process group id. (required) Returns: - tuple: (:class:`~nipyapi.nifi.models.ConfigurationStepNamesEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id'] + all_params = ['id', 'process_group_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -1933,20 +2863,26 @@ def get_connector_configuration_steps_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connector_configuration_steps" % key + " to method get_connector_process_group_status_history" % 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_connector_configuration_steps`") + raise ValueError("Missing the required parameter `id` when calling `get_connector_process_group_status_history`") + # verify the required parameter 'process_group_id' is set + if ('process_group_id' not in params) or (params['process_group_id'] is None): + raise ValueError("Missing the required parameter `process_group_id` when calling `get_connector_process_group_status_history`") + collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] + if 'process_group_id' in params: + path_params['processGroupId'] = params['process_group_id'] query_params = [] @@ -1963,63 +2899,63 @@ def get_connector_configuration_steps_with_http_info(self, id, **kwargs): # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/configuration-steps', 'GET', + return self.api_client.call_api('/connectors/{id}/process-groups/{processGroupId}/status/history', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConfigurationStepNamesEntity', + response_type='StatusHistoryEntity', auth_settings=auth_settings, _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_connector_controller_service_state(self, id, controller_service_id, **kwargs): + def get_connector_processor_state(self, id, processor_id, **kwargs): """ - Gets the state for a controller service within a connector. + Gets the state for a processor within a connector. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``get_connector_controller_service_state_with_http_info()`` method instead. + ``get_connector_processor_state_with_http_info()`` method instead. Args: id (str): The connector id. (required) - controller_service_id (str): - The controller service id. (required) + processor_id (str): + The processor id. (required) Returns: :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connector_controller_service_state_with_http_info(id, controller_service_id, **kwargs) + return self.get_connector_processor_state_with_http_info(id, processor_id, **kwargs) else: - (data) = self.get_connector_controller_service_state_with_http_info(id, controller_service_id, **kwargs) + (data) = self.get_connector_processor_state_with_http_info(id, processor_id, **kwargs) return data - def get_connector_controller_service_state_with_http_info(self, id, controller_service_id, **kwargs): + def get_connector_processor_state_with_http_info(self, id, processor_id, **kwargs): """ - Gets the state for a controller service within a connector. + Gets the state for a processor within a connector. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``get_connector_controller_service_state()`` method instead. + For just the response data, use the corresponding ``get_connector_processor_state()`` method instead. Args: id (str): The connector id. (required) - controller_service_id (str): - The controller service id. (required) + processor_id (str): + The processor id. (required) Returns: tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. """ - all_params = ['id', 'controller_service_id'] + all_params = ['id', 'processor_id'] all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') @@ -2029,16 +2965,16 @@ def get_connector_controller_service_state_with_http_info(self, id, controller_s if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connector_controller_service_state" % key + " to method get_connector_processor_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_connector_controller_service_state`") - # verify the required parameter 'controller_service_id' is set - if ('controller_service_id' not in params) or (params['controller_service_id'] is None): - raise ValueError("Missing the required parameter `controller_service_id` when calling `get_connector_controller_service_state`") + raise ValueError("Missing the required parameter `id` when calling `get_connector_processor_state`") + # verify the required parameter 'processor_id' is set + if ('processor_id' not in params) or (params['processor_id'] is None): + raise ValueError("Missing the required parameter `processor_id` when calling `get_connector_processor_state`") @@ -2047,8 +2983,8 @@ def get_connector_controller_service_state_with_http_info(self, id, controller_s path_params = {} if 'id' in params: path_params['id'] = params['id'] - if 'controller_service_id' in params: - path_params['controllerServiceId'] = params['controller_service_id'] + if 'processor_id' in params: + path_params['processorId'] = params['processor_id'] query_params = [] @@ -2065,7 +3001,7 @@ def get_connector_controller_service_state_with_http_info(self, id, controller_s # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/controller-services/{controllerServiceId}/state', 'GET', + return self.api_client.call_api('/connectors/{id}/processors/{processorId}/state', 'GET', path_params, query_params, header_params, @@ -2079,13 +3015,13 @@ def get_connector_controller_service_state_with_http_info(self, id, controller_s _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_connector_processor_state(self, id, processor_id, **kwargs): + def get_connector_processor_status_history(self, id, processor_id, **kwargs): """ - Gets the state for a processor within a connector. + Gets the status history for a processor within a connector. This method makes a synchronous HTTP request and returns the response data directly. For full HTTP response details (status code, headers, etc.), use the corresponding - ``get_connector_processor_state_with_http_info()`` method instead. + ``get_connector_processor_status_history_with_http_info()`` method instead. Args: id (str): @@ -2094,22 +3030,22 @@ def get_connector_processor_state(self, id, processor_id, **kwargs): The processor id. (required) Returns: - :class:`~nipyapi.nifi.models.ComponentStateEntity`: The response data. + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_connector_processor_state_with_http_info(id, processor_id, **kwargs) + return self.get_connector_processor_status_history_with_http_info(id, processor_id, **kwargs) else: - (data) = self.get_connector_processor_state_with_http_info(id, processor_id, **kwargs) + (data) = self.get_connector_processor_status_history_with_http_info(id, processor_id, **kwargs) return data - def get_connector_processor_state_with_http_info(self, id, processor_id, **kwargs): + def get_connector_processor_status_history_with_http_info(self, id, processor_id, **kwargs): """ - Gets the state for a processor within a connector. + Gets the status history for a processor within a connector. This method makes a synchronous HTTP request and returns detailed response information. Returns the response data along with HTTP status code, headers, and other metadata. - For just the response data, use the corresponding ``get_connector_processor_state()`` method instead. + For just the response data, use the corresponding ``get_connector_processor_status_history()`` method instead. Args: id (str): @@ -2118,7 +3054,7 @@ def get_connector_processor_state_with_http_info(self, id, processor_id, **kwarg The processor id. (required) Returns: - tuple: (:class:`~nipyapi.nifi.models.ComponentStateEntity`, status_code, headers) - Response data with HTTP details. + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. """ all_params = ['id', 'processor_id'] @@ -2131,16 +3067,16 @@ def get_connector_processor_state_with_http_info(self, id, processor_id, **kwarg if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_connector_processor_state" % key + " to method get_connector_processor_status_history" % 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_connector_processor_state`") + raise ValueError("Missing the required parameter `id` when calling `get_connector_processor_status_history`") # verify the required parameter 'processor_id' is set if ('processor_id' not in params) or (params['processor_id'] is None): - raise ValueError("Missing the required parameter `processor_id` when calling `get_connector_processor_state`") + raise ValueError("Missing the required parameter `processor_id` when calling `get_connector_processor_status_history`") @@ -2167,14 +3103,14 @@ def get_connector_processor_state_with_http_info(self, id, processor_id, **kwarg # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/processors/{processorId}/state', 'GET', + return self.api_client.call_api('/connectors/{id}/processors/{processorId}/status/history', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ComponentStateEntity', + response_type='StatusHistoryEntity', auth_settings=auth_settings, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), @@ -2270,24 +3206,126 @@ def get_connector_property_allowable_values_with_http_info(self, id, configurati - - - + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + if 'configuration_step_name' in params: + path_params['configurationStepName'] = params['configuration_step_name'] + if 'property_group_name' in params: + path_params['propertyGroupName'] = params['property_group_name'] + if 'property_name' in params: + path_params['propertyName'] = params['property_name'] + + query_params = [] + if 'filter' in params: + query_params.append(('filter', params['filter'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}/property-groups/{propertyGroupName}/properties/{propertyName}/allowable-values', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectorPropertyAllowableValuesEntity', + auth_settings=auth_settings, + _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_connector_remote_process_group_status_history(self, id, remote_process_group_id, **kwargs): + """ + Gets the status history for a remote process group within a connector. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_connector_remote_process_group_status_history_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + remote_process_group_id (str): + The remote process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.StatusHistoryEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connector_remote_process_group_status_history_with_http_info(id, remote_process_group_id, **kwargs) + else: + (data) = self.get_connector_remote_process_group_status_history_with_http_info(id, remote_process_group_id, **kwargs) + return data + + def get_connector_remote_process_group_status_history_with_http_info(self, id, remote_process_group_id, **kwargs): + """ + Gets the status history for a remote process group within a connector. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_connector_remote_process_group_status_history()`` method instead. + + Args: + id (str): + The connector id. (required) + remote_process_group_id (str): + The remote process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.StatusHistoryEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'remote_process_group_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connector_remote_process_group_status_history" % 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_connector_remote_process_group_status_history`") + # verify the required parameter 'remote_process_group_id' is set + if ('remote_process_group_id' not in params) or (params['remote_process_group_id'] is None): + raise ValueError("Missing the required parameter `remote_process_group_id` when calling `get_connector_remote_process_group_status_history`") + + + collection_formats = {} path_params = {} if 'id' in params: path_params['id'] = params['id'] - if 'configuration_step_name' in params: - path_params['configurationStepName'] = params['configuration_step_name'] - if 'property_group_name' in params: - path_params['propertyGroupName'] = params['property_group_name'] - if 'property_name' in params: - path_params['propertyName'] = params['property_name'] + if 'remote_process_group_id' in params: + path_params['remoteProcessGroupId'] = params['remote_process_group_id'] query_params = [] - if 'filter' in params: - query_params.append(('filter', params['filter'])) header_params = {} @@ -2302,14 +3340,14 @@ def get_connector_property_allowable_values_with_http_info(self, id, configurati # Authentication setting auth_settings = ['bearerAuth'] - return self.api_client.call_api('/connectors/{id}/configuration-steps/{configurationStepName}/property-groups/{propertyGroupName}/properties/{propertyName}/allowable-values', 'GET', + return self.api_client.call_api('/connectors/{id}/remote-process-groups/{remoteProcessGroupId}/status/history', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='ConnectorPropertyAllowableValuesEntity', + response_type='StatusHistoryEntity', auth_settings=auth_settings, _return_http_data_only=params.get('_return_http_data_only'), _preload_content=params.get('_preload_content', True), @@ -2679,6 +3717,194 @@ def get_flow_with_http_info(self, connector_id, process_group_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_migration_request(self, id, request_id, **kwargs): + """ + Gets the Connector migration request with the given ID. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_migration_request_with_http_info()`` method instead. + + Args: + id (str): (required) + request_id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.MigrationRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_migration_request_with_http_info(id, request_id, **kwargs) + else: + (data) = self.get_migration_request_with_http_info(id, request_id, **kwargs) + return data + + def get_migration_request_with_http_info(self, id, request_id, **kwargs): + """ + Gets the Connector migration request with the given ID. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_migration_request()`` method instead. + + Args: + id (str): (required) + request_id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.MigrationRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'request_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_migration_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_migration_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 `get_migration_request`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/migration-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='MigrationRequestEntity', + auth_settings=auth_settings, + _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_migration_sources(self, id, **kwargs): + """ + Lists the Versioned Process Groups that the Connector can be migrated from. + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_migration_sources_with_http_info()`` method instead. + + Args: + id (str): (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowMigrationSourcesEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_migration_sources_with_http_info(id, **kwargs) + else: + (data) = self.get_migration_sources_with_http_info(id, **kwargs) + return data + + def get_migration_sources_with_http_info(self, id, **kwargs): + """ + Lists the Versioned Process Groups that the Connector can be migrated from. + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_migration_sources()`` method instead. + + Args: + id (str): (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowMigrationSourcesEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_migration_sources" % 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_migration_sources`") + + + 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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/migration-sources', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionedFlowMigrationSourcesEntity', + auth_settings=auth_settings, + _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_for_connector_process_group(self, connector_id, process_group_id, **kwargs): """ Gets the parameter context bound to a process group within a connector. @@ -3428,6 +4654,104 @@ def submit_configuration_step_verification_request_with_http_info(self, body, id _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def submit_connector_backlog_request(self, id, **kwargs): + """ + Initiates a request to determine the current backlog for a Connector. + + This will initiate the process of determining the backlog for a Connector. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /connectors/{id}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /connectors/{id}/backlog-requests/{requestId}. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``submit_connector_backlog_request_with_http_info()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_connector_backlog_request_with_http_info(id, **kwargs) + else: + (data) = self.submit_connector_backlog_request_with_http_info(id, **kwargs) + return data + + def submit_connector_backlog_request_with_http_info(self, id, **kwargs): + """ + Initiates a request to determine the current backlog for a Connector. + + This will initiate the process of determining the backlog for a Connector. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /connectors/{id}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /connectors/{id}/backlog-requests/{requestId}. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``submit_connector_backlog_request()`` method instead. + + Args: + id (str): + The connector id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_connector_backlog_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 `submit_connector_backlog_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/connectors/{id}/backlog-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BacklogRequestEntity', + auth_settings=auth_settings, + _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_connector(self, body, id, **kwargs): """ Updates a connector. diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index 625fd910..99cfda00 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 a9d3a15d..7638a12b 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 c667b646..336ad03a 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 9f468a60..f918d50c 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 5bc44adb..b9654cbc 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flow_file_queues_api.py b/nipyapi/nifi/apis/flow_file_queues_api.py index 058b57f7..4b2f51be 100644 --- a/nipyapi/nifi/apis/flow_file_queues_api.py +++ b/nipyapi/nifi/apis/flow_file_queues_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/funnels_api.py b/nipyapi/nifi/apis/funnels_api.py index eea1f2d2..6f37ce94 100644 --- a/nipyapi/nifi/apis/funnels_api.py +++ b/nipyapi/nifi/apis/funnels_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 7edf6d33..cb9333de 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 fa23346f..bbc93d4e 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 c79cb49d..78820547 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 index a71b19a1..c6915529 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_providers_api.py b/nipyapi/nifi/apis/parameter_providers_api.py index cd792478..36d5cab9 100644 --- a/nipyapi/nifi/apis/parameter_providers_api.py +++ b/nipyapi/nifi/apis/parameter_providers_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 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 44d1ae31..20e14453 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 ae811664..3c262187 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 44a1f91f..650dc5a8 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -347,6 +347,114 @@ def clear_state3_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_backlog_request(self, id, request_id, **kwargs): + """ + Deletes the Backlog Request with the given ID. + + Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_backlog_request_with_http_info()`` method instead. + + Args: + id (str): + The processor id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_backlog_request_with_http_info(id, request_id, **kwargs) + else: + (data) = self.delete_backlog_request_with_http_info(id, request_id, **kwargs) + return data + + def delete_backlog_request_with_http_info(self, id, request_id, **kwargs): + """ + Deletes the Backlog Request with the given ID. + + Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``delete_backlog_request()`` method instead. + + Args: + id (str): + The processor id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'request_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_backlog_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_backlog_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_backlog_request`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/processors/{id}/backlog-requests/{requestId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BacklogRequestEntity', + auth_settings=auth_settings, + _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_processor(self, id, **kwargs): """ Deletes a processor. @@ -568,6 +676,114 @@ def delete_verification_request2_with_http_info(self, id, request_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_backlog_request(self, id, request_id, **kwargs): + """ + Returns the Backlog Request with the given ID. + + Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /processors/{processorId}/backlog-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 the backlog once the request is complete. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_backlog_request_with_http_info()`` method instead. + + Args: + id (str): + The processor id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_backlog_request_with_http_info(id, request_id, **kwargs) + else: + (data) = self.get_backlog_request_with_http_info(id, request_id, **kwargs) + return data + + def get_backlog_request_with_http_info(self, id, request_id, **kwargs): + """ + Returns the Backlog Request with the given ID. + + Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /processors/{processorId}/backlog-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 the backlog once the request is complete. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_backlog_request()`` method instead. + + Args: + id (str): + The processor id. (required) + request_id (str): + The ID of the Backlog Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'request_id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_backlog_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_backlog_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 `get_backlog_request`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/processors/{id}/backlog-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BacklogRequestEntity', + auth_settings=auth_settings, + _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_processor(self, id, **kwargs): """ Gets a processor. @@ -1167,6 +1383,104 @@ def get_verification_request2_with_http_info(self, id, request_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def submit_processor_backlog_request(self, id, **kwargs): + """ + Initiates a request to determine the current backlog for a processor that implements BacklogReportingProcessor. + + This will initiate the process of determining the backlog for a Processor. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/backlog-requests/{requestId}. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``submit_processor_backlog_request_with_http_info()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + :class:`~nipyapi.nifi.models.BacklogRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_processor_backlog_request_with_http_info(id, **kwargs) + else: + (data) = self.submit_processor_backlog_request_with_http_info(id, **kwargs) + return data + + def submit_processor_backlog_request_with_http_info(self, id, **kwargs): + """ + Initiates a request to determine the current backlog for a processor that implements BacklogReportingProcessor. + + This will initiate the process of determining the backlog for a Processor. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/backlog-requests/{requestId}. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``submit_processor_backlog_request()`` method instead. + + Args: + id (str): + The processor id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.BacklogRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_processor_backlog_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 `submit_processor_backlog_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/processors/{id}/backlog-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BacklogRequestEntity', + auth_settings=auth_settings, + _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_processor_verification_request(self, body, id, **kwargs): """ Performs verification of the Processor's configuration. diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 5eda1bdd..52bf951d 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 1bfa163b..d45987eb 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 2d151e82..4c497a2c 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 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 3078abe0..bfbed2ee 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 17d82589..ed4a1d6b 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 b95045c7..ea5b4973 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 ecddb07c..747d6c2a 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 8bc49188..562d7866 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 fade1a25..67eee918 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 981b928d..c0f16527 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -32,6 +32,118 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client + def apply_rebased_flow_version(self, body, id, **kwargs): + """ + Applies a rebased flow to a Process Group with the given ID on this node. + + This endpoint is used internally to apply a rebase to a Process Group on each node of a cluster. It synchronizes the flow to the supplied merged snapshot and then resets the Version Control Information to the clean target version so that the preserved local changes are detected as local modifications. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``apply_rebased_flow_version_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedFlowSnapshotEntity`): + The rebased versioned flow snapshot. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionControlInformationEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.apply_rebased_flow_version_with_http_info(body, id, **kwargs) + else: + (data) = self.apply_rebased_flow_version_with_http_info(body, id, **kwargs) + return data + + def apply_rebased_flow_version_with_http_info(self, body, id, **kwargs): + """ + Applies a rebased flow to a Process Group with the given ID on this node. + + This endpoint is used internally to apply a rebase to a Process Group on each node of a cluster. It synchronizes the flow to the supplied merged snapshot and then resets the Version Control Information to the clean target version so that the preserved local changes are detected as local modifications. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``apply_rebased_flow_version()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.VersionedFlowSnapshotEntity`): + The rebased versioned flow snapshot. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionControlInformationEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['body', 'id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method apply_rebased_flow_version" % 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 `apply_rebased_flow_version`") + # 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 `apply_rebased_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 + 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 = ['bearerAuth'] + + return self.api_client.call_api('/versions/process-groups/{id}/rebase', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionControlInformationEntity', + auth_settings=auth_settings, + _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_flow_branch(self, body, id, **kwargs): """ Creates a new branch for a version controlled Process Group. @@ -246,6 +358,111 @@ def create_version_control_request_with_http_info(self, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_rebase_request(self, id, **kwargs): + """ + Deletes the Rebase Request with the given ID. + + Deletes the Rebase Request with the given ID. After a request is created via a POST to /versions/rebase-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Rebase process has completed. If the request is deleted before the request completes, then the Rebase 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 and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``delete_rebase_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Rebase Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_rebase_request_with_http_info(id, **kwargs) + else: + (data) = self.delete_rebase_request_with_http_info(id, **kwargs) + return data + + def delete_rebase_request_with_http_info(self, id, **kwargs): + """ + Deletes the Rebase Request with the given ID. + + Deletes the Rebase Request with the given ID. After a request is created via a POST to /versions/rebase-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Rebase process has completed. If the request is deleted before the request completes, then the Rebase 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 and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``delete_rebase_request()`` method instead. + + Args: + id (str): + The ID of the Rebase Request (required) + disconnected_node_acknowledged (bool): + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'disconnected_node_acknowledged'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_rebase_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_rebase_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/versions/rebase-requests/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionedFlowUpdateRequestEntity', + auth_settings=auth_settings, + _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_revert_request(self, id, **kwargs): """ Deletes the Revert Request with the given ID. @@ -649,6 +866,212 @@ def export_flow_version_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_rebase_analysis(self, id, target_version, **kwargs): + """ + Gets a Rebase Analysis for a Process Group. + + For a Process Group that is under Version Control, this will perform a rebase analysis by comparing local modifications against upstream changes between the current version and the specified target version. The analysis determines whether a rebase is allowed or if there are conflicts. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_rebase_analysis_with_http_info()`` method instead. + + Args: + id (str): + The process group id. (required) + target_version (str): + The target version to rebase to. (required) + + Returns: + :class:`~nipyapi.nifi.models.RebaseAnalysisEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_rebase_analysis_with_http_info(id, target_version, **kwargs) + else: + (data) = self.get_rebase_analysis_with_http_info(id, target_version, **kwargs) + return data + + def get_rebase_analysis_with_http_info(self, id, target_version, **kwargs): + """ + Gets a Rebase Analysis for a Process Group. + + For a Process Group that is under Version Control, this will perform a rebase analysis by comparing local modifications against upstream changes between the current version and the specified target version. The analysis determines whether a rebase is allowed or if there are conflicts. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_rebase_analysis()`` method instead. + + Args: + id (str): + The process group id. (required) + target_version (str): + The target version to rebase to. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.RebaseAnalysisEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id', 'target_version'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_rebase_analysis" % 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_rebase_analysis`") + # verify the required parameter 'target_version' is set + if ('target_version' not in params) or (params['target_version'] is None): + raise ValueError("Missing the required parameter `target_version` when calling `get_rebase_analysis`") + + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'target_version' in params: + query_params.append(('targetVersion', params['target_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/versions/rebase-analysis/process-groups/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='RebaseAnalysisEntity', + auth_settings=auth_settings, + _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_rebase_request(self, id, **kwargs): + """ + Returns the Rebase Request with the given ID. + + Returns the Rebase Request with the given ID. Once a Rebase Request has been created by performing a POST to /versions/rebase-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``get_rebase_request_with_http_info()`` method instead. + + Args: + id (str): + The ID of the Rebase Request (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_rebase_request_with_http_info(id, **kwargs) + else: + (data) = self.get_rebase_request_with_http_info(id, **kwargs) + return data + + def get_rebase_request_with_http_info(self, id, **kwargs): + """ + Returns the Rebase Request with the given ID. + + Returns the Rebase Request with the given ID. Once a Rebase Request has been created by performing a POST to /versions/rebase-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``get_rebase_request()`` method instead. + + Args: + id (str): + The ID of the Rebase Request (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_rebase_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_rebase_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']) + + # Authentication setting + auth_settings = ['bearerAuth'] + + return self.api_client.call_api('/versions/rebase-requests/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionedFlowUpdateRequestEntity', + auth_settings=auth_settings, + _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. @@ -943,6 +1366,118 @@ def get_version_information_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def initiate_rebase(self, body, id, **kwargs): + """ + Initiate a Rebase Request for a Process Group with the given ID. + + For a Process Group that is already under Version Control, this will initiate the action of rebasing the flow to a different version while preserving compatible local changes. 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 rebasing 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/rebase-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/rebase-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns the response data directly. + + For full HTTP response details (status code, headers, etc.), use the corresponding + ``initiate_rebase_with_http_info()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RebaseRequestEntity`): + The rebase request details. (required) + id (str): + The process group id. (required) + + Returns: + :class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`: The response data. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.initiate_rebase_with_http_info(body, id, **kwargs) + else: + (data) = self.initiate_rebase_with_http_info(body, id, **kwargs) + return data + + def initiate_rebase_with_http_info(self, body, id, **kwargs): + """ + Initiate a Rebase Request for a Process Group with the given ID. + + For a Process Group that is already under Version Control, this will initiate the action of rebasing the flow to a different version while preserving compatible local changes. 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 rebasing 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/rebase-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/rebase-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve. + + This method makes a synchronous HTTP request and returns detailed response information. + + Returns the response data along with HTTP status code, headers, and other metadata. + For just the response data, use the corresponding ``initiate_rebase()`` method instead. + + Args: + body (:class:`~nipyapi.nifi.models.RebaseRequestEntity`): + The rebase request details. (required) + id (str): + The process group id. (required) + + Returns: + tuple: (:class:`~nipyapi.nifi.models.VersionedFlowUpdateRequestEntity`, status_code, headers) - Response data with HTTP details. + """ + + all_params = ['body', 'id'] + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in params['kwargs'].items(): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method initiate_rebase" % 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 `initiate_rebase`") + # 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_rebase`") + + + + 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 = ['bearerAuth'] + + return self.api_client.call_api('/versions/rebase-requests/process-groups/{id}', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionedFlowUpdateRequestEntity', + auth_settings=auth_settings, + _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 initiate_revert_flow_version(self, body, id, **kwargs): """ Initiate the Revert Request of a Process Group with the given ID. diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 50f81690..51ff313a 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -44,6 +44,10 @@ def __init__(self): self.api_client = None # Temp file folder for downloading files self.temp_folder_path = None + # Validate enum-constrained model fields when they are set. + # Set to False to accept values the generated enums do not list yet + # (e.g. a newer server than the spec the client was generated from). + self.client_side_validation = True # Authentication Settings self.force_basic_auth = False @@ -245,6 +249,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 2.10.0\n"\ + "Version of the API: 2.12.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 93c5ed04..b67661a9 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,6 +33,10 @@ from .attribute_dto import AttributeDTO from .authentication_configuration_dto import AuthenticationConfigurationDTO from .authentication_configuration_entity import AuthenticationConfigurationEntity +from .backlog_dto import BacklogDTO +from .backlog_request_dto import BacklogRequestDTO +from .backlog_request_entity import BacklogRequestEntity +from .backlog_update_step_dto import BacklogUpdateStepDTO from .banner_dto import BannerDTO from .banner_entity import BannerEntity from .batch_settings_dto import BatchSettingsDTO @@ -208,6 +212,12 @@ from .listing_request_dto import ListingRequestDTO from .listing_request_entity import ListingRequestEntity from .long_parameter import LongParameter +from .migration_payload_dto import MigrationPayloadDTO +from .migration_payload_entity import MigrationPayloadEntity +from .migration_request_dto import MigrationRequestDTO +from .migration_request_entity import MigrationRequestEntity +from .migration_request_local_source_dto import MigrationRequestLocalSourceDTO +from .migration_update_step_dto import MigrationUpdateStepDTO from .multi_processor_use_case import MultiProcessorUseCase from .nar_coordinate_dto import NarCoordinateDTO from .nar_details_entity import NarDetailsEntity @@ -332,6 +342,9 @@ from .provenance_search_value_dto import ProvenanceSearchValueDTO from .provenance_searchable_field_dto import ProvenanceSearchableFieldDTO from .queue_size_dto import QueueSizeDTO +from .rebase_analysis_entity import RebaseAnalysisEntity +from .rebase_change_dto import RebaseChangeDTO +from .rebase_request_entity import RebaseRequestEntity from .registered_flow import RegisteredFlow from .registered_flow_snapshot import RegisteredFlowSnapshot from .registered_flow_snapshot_metadata import RegisteredFlowSnapshotMetadata @@ -422,6 +435,8 @@ from .versioned_flow_coordinates import VersionedFlowCoordinates from .versioned_flow_dto import VersionedFlowDTO from .versioned_flow_entity import VersionedFlowEntity +from .versioned_flow_migration_source_dto import VersionedFlowMigrationSourceDTO +from .versioned_flow_migration_sources_entity import VersionedFlowMigrationSourcesEntity from .versioned_flow_snapshot_entity import VersionedFlowSnapshotEntity from .versioned_flow_snapshot_metadata_entity import VersionedFlowSnapshotMetadataEntity from .versioned_flow_snapshot_metadata_set_entity import VersionedFlowSnapshotMetadataSetEntity diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index b9f6d478..3c8fbb16 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AboutDTO(object): """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 54ee426c..6f2f7dbe 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AboutEntity(object): """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index 3a11968f..7bf082c5 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicyDTO(object): """ @@ -107,12 +109,13 @@ def action(self, action): :param action: The action of this AccessPolicyDTO. :type: str """ - allowed_values = ["read", "write", ] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["read", "write", ] + 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 diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index 30a26cd7..a9b8a6fd 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicyEntity(object): """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index 7915c332..f17d9e00 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicySummaryDTO(object): """ @@ -97,12 +99,13 @@ def action(self, action): :param action: The action of this AccessPolicySummaryDTO. :type: str """ - allowed_values = ["read", "write", ] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["read", "write", ] + 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 diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index f55232b6..1a7e38b7 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicySummaryEntity(object): """ diff --git a/nipyapi/nifi/models/access_token_body.py b/nipyapi/nifi/models/access_token_body.py index bcff0895..6f4621ae 100644 --- a/nipyapi/nifi/models/access_token_body.py +++ b/nipyapi/nifi/models/access_token_body.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessTokenBody(object): """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 859e59a3..2f06f174 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ActionDetailsDTO(object): """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index 54d24444..5db849e5 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ActionDTO(object): """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index 06a90cf9..8b413ed7 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ActionEntity(object): """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index 62dbe529..5e89d2db 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ActivateControllerServicesEntity(object): """ @@ -146,12 +148,13 @@ def state(self, state): :param state: The state of this ActivateControllerServicesEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/additional_details_entity.py b/nipyapi/nifi/models/additional_details_entity.py index ea0fcf1f..f900bbd4 100644 --- a/nipyapi/nifi/models/additional_details_entity.py +++ b/nipyapi/nifi/models/additional_details_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AdditionalDetailsEntity(object): """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index 8be55ded..cb94141e 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AffectedComponentDTO(object): """ @@ -184,12 +186,13 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this AffectedComponentDTO. :type: str """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP", ] + 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 diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 55462721..9ab08a44 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AffectedComponentEntity(object): """ @@ -260,12 +262,13 @@ def reference_type(self, reference_type): :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index 2e7d3392..3372815d 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AllowableValueDTO(object): """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 572f3c92..4a8bb18b 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AllowableValueEntity(object): """ diff --git a/nipyapi/nifi/models/asset_dto.py b/nipyapi/nifi/models/asset_dto.py index 40965814..e38a85c0 100644 --- a/nipyapi/nifi/models/asset_dto.py +++ b/nipyapi/nifi/models/asset_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AssetDTO(object): """ diff --git a/nipyapi/nifi/models/asset_entity.py b/nipyapi/nifi/models/asset_entity.py index 6c5b9024..b1237863 100644 --- a/nipyapi/nifi/models/asset_entity.py +++ b/nipyapi/nifi/models/asset_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AssetEntity(object): """ diff --git a/nipyapi/nifi/models/asset_reference_dto.py b/nipyapi/nifi/models/asset_reference_dto.py index 457983db..73285d48 100644 --- a/nipyapi/nifi/models/asset_reference_dto.py +++ b/nipyapi/nifi/models/asset_reference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AssetReferenceDTO(object): """ diff --git a/nipyapi/nifi/models/assets_entity.py b/nipyapi/nifi/models/assets_entity.py index 530b4fd9..3aaf6efa 100644 --- a/nipyapi/nifi/models/assets_entity.py +++ b/nipyapi/nifi/models/assets_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AssetsEntity(object): """ diff --git a/nipyapi/nifi/models/attribute.py b/nipyapi/nifi/models/attribute.py index 5d896321..05abeb8b 100644 --- a/nipyapi/nifi/models/attribute.py +++ b/nipyapi/nifi/models/attribute.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Attribute(object): """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index 99591511..c6f4661c 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AttributeDTO(object): """ diff --git a/nipyapi/nifi/models/authentication_configuration_dto.py b/nipyapi/nifi/models/authentication_configuration_dto.py index da0c8a81..46c23adf 100644 --- a/nipyapi/nifi/models/authentication_configuration_dto.py +++ b/nipyapi/nifi/models/authentication_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AuthenticationConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/authentication_configuration_entity.py b/nipyapi/nifi/models/authentication_configuration_entity.py index d3025678..403c07d4 100644 --- a/nipyapi/nifi/models/authentication_configuration_entity.py +++ b/nipyapi/nifi/models/authentication_configuration_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AuthenticationConfigurationEntity(object): """ diff --git a/nipyapi/nifi/models/backlog_dto.py b/nipyapi/nifi/models/backlog_dto.py new file mode 100644 index 00000000..401631db --- /dev/null +++ b/nipyapi/nifi/models/backlog_dto.py @@ -0,0 +1,352 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class BacklogDTO(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 = { + 'byte_count': 'int', +'flow_file_count': 'int', +'formatted_byte_count': 'str', +'formatted_flow_file_count': 'str', +'formatted_last_caught_up': 'str', +'formatted_record_count': 'str', +'last_caught_up': 'str', +'precision': 'str', +'record_count': 'int' } + + attribute_map = { + 'byte_count': 'byteCount', +'flow_file_count': 'flowFileCount', +'formatted_byte_count': 'formattedByteCount', +'formatted_flow_file_count': 'formattedFlowFileCount', +'formatted_last_caught_up': 'formattedLastCaughtUp', +'formatted_record_count': 'formattedRecordCount', +'last_caught_up': 'lastCaughtUp', +'precision': 'precision', +'record_count': 'recordCount' } + + def __init__(self, byte_count=None, flow_file_count=None, formatted_byte_count=None, formatted_flow_file_count=None, formatted_last_caught_up=None, formatted_record_count=None, last_caught_up=None, precision=None, record_count=None): + """ + BacklogDTO - a model defined in Swagger + """ + + self._byte_count = None + self._flow_file_count = None + self._formatted_byte_count = None + self._formatted_flow_file_count = None + self._formatted_last_caught_up = None + self._formatted_record_count = None + self._last_caught_up = None + self._precision = None + self._record_count = None + + if byte_count is not None: + self.byte_count = byte_count + if flow_file_count is not None: + self.flow_file_count = flow_file_count + if formatted_byte_count is not None: + self.formatted_byte_count = formatted_byte_count + if formatted_flow_file_count is not None: + self.formatted_flow_file_count = formatted_flow_file_count + if formatted_last_caught_up is not None: + self.formatted_last_caught_up = formatted_last_caught_up + if formatted_record_count is not None: + self.formatted_record_count = formatted_record_count + if last_caught_up is not None: + self.last_caught_up = last_caught_up + if precision is not None: + self.precision = precision + if record_count is not None: + self.record_count = record_count + + @property + def byte_count(self): + """ + Gets the byte_count of this BacklogDTO. + The total number of bytes remaining on the source, if the component can determine it. + + :return: The byte_count of this BacklogDTO. + :rtype: int + """ + return self._byte_count + + @byte_count.setter + def byte_count(self, byte_count): + """ + Sets the byte_count of this BacklogDTO. + The total number of bytes remaining on the source, if the component can determine it. + + :param byte_count: The byte_count of this BacklogDTO. + :type: int + """ + + self._byte_count = byte_count + + @property + def flow_file_count(self): + """ + Gets the flow_file_count of this BacklogDTO. + The number of FlowFiles remaining on the source, if the component can determine it. + + :return: The flow_file_count of this BacklogDTO. + :rtype: int + """ + return self._flow_file_count + + @flow_file_count.setter + def flow_file_count(self, flow_file_count): + """ + Sets the flow_file_count of this BacklogDTO. + The number of FlowFiles remaining on the source, if the component can determine it. + + :param flow_file_count: The flow_file_count of this BacklogDTO. + :type: int + """ + + self._flow_file_count = flow_file_count + + @property + def formatted_byte_count(self): + """ + Gets the formatted_byte_count of this BacklogDTO. + The byte count formatted for display in human-readable units (for example, '4.89 GB'). Populated whenever byteCount is populated. + + :return: The formatted_byte_count of this BacklogDTO. + :rtype: str + """ + return self._formatted_byte_count + + @formatted_byte_count.setter + def formatted_byte_count(self, formatted_byte_count): + """ + Sets the formatted_byte_count of this BacklogDTO. + The byte count formatted for display in human-readable units (for example, '4.89 GB'). Populated whenever byteCount is populated. + + :param formatted_byte_count: The formatted_byte_count of this BacklogDTO. + :type: str + """ + + self._formatted_byte_count = formatted_byte_count + + @property + def formatted_flow_file_count(self): + """ + Gets the formatted_flow_file_count of this BacklogDTO. + The FlowFile count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever flowFileCount is populated. + + :return: The formatted_flow_file_count of this BacklogDTO. + :rtype: str + """ + return self._formatted_flow_file_count + + @formatted_flow_file_count.setter + def formatted_flow_file_count(self, formatted_flow_file_count): + """ + Sets the formatted_flow_file_count of this BacklogDTO. + The FlowFile count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever flowFileCount is populated. + + :param formatted_flow_file_count: The formatted_flow_file_count of this BacklogDTO. + :type: str + """ + + self._formatted_flow_file_count = formatted_flow_file_count + + @property + def formatted_last_caught_up(self): + """ + Gets the formatted_last_caught_up of this BacklogDTO. + Human-readable description of how long ago the component was last caught up, for example '5 mins ago', 'in 2 hours', or 'now'. Populated whenever lastCaughtUp is populated. + + :return: The formatted_last_caught_up of this BacklogDTO. + :rtype: str + """ + return self._formatted_last_caught_up + + @formatted_last_caught_up.setter + def formatted_last_caught_up(self, formatted_last_caught_up): + """ + Sets the formatted_last_caught_up of this BacklogDTO. + Human-readable description of how long ago the component was last caught up, for example '5 mins ago', 'in 2 hours', or 'now'. Populated whenever lastCaughtUp is populated. + + :param formatted_last_caught_up: The formatted_last_caught_up of this BacklogDTO. + :type: str + """ + + self._formatted_last_caught_up = formatted_last_caught_up + + @property + def formatted_record_count(self): + """ + Gets the formatted_record_count of this BacklogDTO. + The record count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever recordCount is populated. + + :return: The formatted_record_count of this BacklogDTO. + :rtype: str + """ + return self._formatted_record_count + + @formatted_record_count.setter + def formatted_record_count(self, formatted_record_count): + """ + Sets the formatted_record_count of this BacklogDTO. + The record count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever recordCount is populated. + + :param formatted_record_count: The formatted_record_count of this BacklogDTO. + :type: str + """ + + self._formatted_record_count = formatted_record_count + + @property + def last_caught_up(self): + """ + Gets the last_caught_up of this BacklogDTO. + The most recent moment the component observed itself as fully caught up with the source, formatted as an ISO-8601 UTC timestamp. + + :return: The last_caught_up of this BacklogDTO. + :rtype: str + """ + return self._last_caught_up + + @last_caught_up.setter + def last_caught_up(self, last_caught_up): + """ + Sets the last_caught_up of this BacklogDTO. + The most recent moment the component observed itself as fully caught up with the source, formatted as an ISO-8601 UTC timestamp. + + :param last_caught_up: The last_caught_up of this BacklogDTO. + :type: str + """ + + self._last_caught_up = last_caught_up + + @property + def precision(self): + """ + Gets the precision of this BacklogDTO. + The precision of the numeric dimensions of this backlog. + + :return: The precision of this BacklogDTO. + :rtype: str + """ + return self._precision + + @precision.setter + def precision(self, precision): + """ + Sets the precision of this BacklogDTO. + The precision of the numeric dimensions of this backlog. + + :param precision: The precision of this BacklogDTO. + :type: str + """ + if Configuration().client_side_validation: + allowed_values = ["EXACT", "AT_LEAST", ] + if precision not in allowed_values: + raise ValueError( + "Invalid value for `precision` ({0}), must be one of {1}" + .format(precision, allowed_values) + ) + + self._precision = precision + + @property + def record_count(self): + """ + Gets the record_count of this BacklogDTO. + The number of records remaining on the source, if the component can determine it. + + :return: The record_count of this BacklogDTO. + :rtype: int + """ + return self._record_count + + @record_count.setter + def record_count(self, record_count): + """ + Sets the record_count of this BacklogDTO. + The number of records remaining on the source, if the component can determine it. + + :param record_count: The record_count of this BacklogDTO. + :type: int + """ + + self._record_count = record_count + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, BacklogDTO): + 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/backlog_request_dto.py b/nipyapi/nifi/models/backlog_request_dto.py new file mode 100644 index 00000000..07407545 --- /dev/null +++ b/nipyapi/nifi/models/backlog_request_dto.py @@ -0,0 +1,399 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class BacklogRequestDTO(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 = { + 'backlog': 'BacklogDTO', +'complete': 'bool', +'component_id': 'str', +'failure_reason': 'str', +'last_updated': 'datetime', +'percent_completed': 'int', +'request_id': 'str', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[BacklogUpdateStepDTO]', +'uri': 'str' } + + attribute_map = { + 'backlog': 'backlog', +'complete': 'complete', +'component_id': 'componentId', +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'percent_completed': 'percentCompleted', +'request_id': 'requestId', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, backlog=None, complete=None, component_id=None, failure_reason=None, last_updated=None, percent_completed=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None): + """ + BacklogRequestDTO - a model defined in Swagger + """ + + self._backlog = None + self._complete = None + self._component_id = None + self._failure_reason = None + self._last_updated = None + self._percent_completed = None + self._request_id = None + self._state = None + self._submission_time = None + self._update_steps = None + self._uri = None + + if backlog is not None: + self.backlog = backlog + if complete is not None: + self.complete = complete + if component_id is not None: + self.component_id = component_id + if failure_reason is not None: + self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated + if percent_completed is not None: + self.percent_completed = percent_completed + if request_id is not None: + self.request_id = request_id + if state is not None: + self.state = state + if submission_time is not None: + self.submission_time = submission_time + if update_steps is not None: + self.update_steps = update_steps + if uri is not None: + self.uri = uri + + @property + def backlog(self): + """ + Gets the backlog of this BacklogRequestDTO. + + :return: The backlog of this BacklogRequestDTO. + :rtype: BacklogDTO + """ + return self._backlog + + @backlog.setter + def backlog(self, backlog): + """ + Sets the backlog of this BacklogRequestDTO. + + :param backlog: The backlog of this BacklogRequestDTO. + :type: BacklogDTO + """ + + self._backlog = backlog + + @property + def complete(self): + """ + Gets the complete of this BacklogRequestDTO. + Whether or not the request is completed + + :return: The complete of this BacklogRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this BacklogRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this BacklogRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def component_id(self): + """ + Gets the component_id of this BacklogRequestDTO. + The ID of the Processor or Connector whose backlog is being determined + + :return: The component_id of this BacklogRequestDTO. + :rtype: str + """ + return self._component_id + + @component_id.setter + def component_id(self, component_id): + """ + Sets the component_id of this BacklogRequestDTO. + The ID of the Processor or Connector whose backlog is being determined + + :param component_id: The component_id of this BacklogRequestDTO. + :type: str + """ + + self._component_id = component_id + + @property + def failure_reason(self): + """ + Gets the failure_reason of this BacklogRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this BacklogRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this BacklogRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this BacklogRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def last_updated(self): + """ + Gets the last_updated of this BacklogRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this BacklogRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this BacklogRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this BacklogRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def percent_completed(self): + """ + Gets the percent_completed of this BacklogRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this BacklogRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this BacklogRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this BacklogRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def request_id(self): + """ + Gets the request_id of this BacklogRequestDTO. + The ID of the request + + :return: The request_id of this BacklogRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this BacklogRequestDTO. + The ID of the request + + :param request_id: The request_id of this BacklogRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def state(self): + """ + Gets the state of this BacklogRequestDTO. + A description of the current state of the request + + :return: The state of this BacklogRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this BacklogRequestDTO. + A description of the current state of the request + + :param state: The state of this BacklogRequestDTO. + :type: str + """ + + self._state = state + + @property + def submission_time(self): + """ + Gets the submission_time of this BacklogRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this BacklogRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this BacklogRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this BacklogRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def update_steps(self): + """ + Gets the update_steps of this BacklogRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this BacklogRequestDTO. + :rtype: list[BacklogUpdateStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this BacklogRequestDTO. + 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 BacklogRequestDTO. + :type: list[BacklogUpdateStepDTO] + """ + + self._update_steps = update_steps + + @property + def uri(self): + """ + Gets the uri of this BacklogRequestDTO. + The URI for the request + + :return: The uri of this BacklogRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this BacklogRequestDTO. + The URI for the request + + :param uri: The uri of this BacklogRequestDTO. + :type: str + """ + + self._uri = uri + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, BacklogRequestDTO): + 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/backlog_request_entity.py b/nipyapi/nifi/models/backlog_request_entity.py new file mode 100644 index 00000000..c8ce65c8 --- /dev/null +++ b/nipyapi/nifi/models/backlog_request_entity.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class BacklogRequestEntity(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': 'BacklogRequestDTO' } + + attribute_map = { + 'request': 'request' } + + def __init__(self, request=None): + """ + BacklogRequestEntity - a model defined in Swagger + """ + + self._request = None + + if request is not None: + self.request = request + + @property + def request(self): + """ + Gets the request of this BacklogRequestEntity. + + :return: The request of this BacklogRequestEntity. + :rtype: BacklogRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this BacklogRequestEntity. + + :param request: The request of this BacklogRequestEntity. + :type: BacklogRequestDTO + """ + + self._request = request + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, BacklogRequestEntity): + 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/backlog_update_step_dto.py b/nipyapi/nifi/models/backlog_update_step_dto.py new file mode 100644 index 00000000..cc4559db --- /dev/null +++ b/nipyapi/nifi/models/backlog_update_step_dto.py @@ -0,0 +1,177 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class BacklogUpdateStepDTO(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 = { + 'complete': 'bool', +'description': 'str', +'failure_reason': 'str' } + + attribute_map = { + 'complete': 'complete', +'description': 'description', +'failure_reason': 'failureReason' } + + def __init__(self, complete=None, description=None, failure_reason=None): + """ + BacklogUpdateStepDTO - a model defined in Swagger + """ + + self._complete = None + self._description = None + self._failure_reason = None + + if complete is not None: + self.complete = complete + if description is not None: + self.description = description + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def complete(self): + """ + Gets the complete of this BacklogUpdateStepDTO. + Whether or not this step has completed + + :return: The complete of this BacklogUpdateStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this BacklogUpdateStepDTO. + Whether or not this step has completed + + :param complete: The complete of this BacklogUpdateStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def description(self): + """ + Gets the description of this BacklogUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this BacklogUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this BacklogUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this BacklogUpdateStepDTO. + :type: str + """ + + self._description = description + + @property + def failure_reason(self): + """ + Gets the failure_reason of this BacklogUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this BacklogUpdateStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this BacklogUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this BacklogUpdateStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, BacklogUpdateStepDTO): + 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/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index 0aaa7ce4..f5652e3f 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BannerDTO(object): """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index fce9dd16..0afa6f25 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BannerEntity(object): """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index a7cd33ec..ed198c7f 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BatchSettingsDTO(object): """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index 2a904c88..53d13a16 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BatchSize(object): """ diff --git a/nipyapi/nifi/models/build_info.py b/nipyapi/nifi/models/build_info.py index 965a1efb..a01e8631 100644 --- a/nipyapi/nifi/models/build_info.py +++ b/nipyapi/nifi/models/build_info.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BuildInfo(object): """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 13595119..68d111a2 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BulletinBoardDTO(object): """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index fbdfb239..7d1ed774 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BulletinBoardEntity(object): """ diff --git a/nipyapi/nifi/models/bulletin_board_pattern_parameter.py b/nipyapi/nifi/models/bulletin_board_pattern_parameter.py index d2413bf8..739edcd5 100644 --- a/nipyapi/nifi/models/bulletin_board_pattern_parameter.py +++ b/nipyapi/nifi/models/bulletin_board_pattern_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BulletinBoardPatternParameter(object): """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 8adaace3..288ed43f 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BulletinDTO(object): """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index df8eda94..564b02d4 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BulletinEntity(object): """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 138f77d3..db7ac6e9 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Bundle(object): """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index 528cfd4c..cecdeea1 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundleDTO(object): """ diff --git a/nipyapi/nifi/models/clear_bulletins_for_group_request_entity.py b/nipyapi/nifi/models/clear_bulletins_for_group_request_entity.py index 36257b86..7b8913d0 100644 --- a/nipyapi/nifi/models/clear_bulletins_for_group_request_entity.py +++ b/nipyapi/nifi/models/clear_bulletins_for_group_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClearBulletinsForGroupRequestEntity(object): """ diff --git a/nipyapi/nifi/models/clear_bulletins_for_group_results_entity.py b/nipyapi/nifi/models/clear_bulletins_for_group_results_entity.py index c325ff5f..7eb7a04d 100644 --- a/nipyapi/nifi/models/clear_bulletins_for_group_results_entity.py +++ b/nipyapi/nifi/models/clear_bulletins_for_group_results_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClearBulletinsForGroupResultsEntity(object): """ diff --git a/nipyapi/nifi/models/clear_bulletins_request_entity.py b/nipyapi/nifi/models/clear_bulletins_request_entity.py index b1e0b030..2d1b9265 100644 --- a/nipyapi/nifi/models/clear_bulletins_request_entity.py +++ b/nipyapi/nifi/models/clear_bulletins_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClearBulletinsRequestEntity(object): """ diff --git a/nipyapi/nifi/models/clear_bulletins_result_entity.py b/nipyapi/nifi/models/clear_bulletins_result_entity.py index b733281c..bd91436a 100644 --- a/nipyapi/nifi/models/clear_bulletins_result_entity.py +++ b/nipyapi/nifi/models/clear_bulletins_result_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClearBulletinsResultEntity(object): """ diff --git a/nipyapi/nifi/models/client_id_parameter.py b/nipyapi/nifi/models/client_id_parameter.py index b569ceb6..06698614 100644 --- a/nipyapi/nifi/models/client_id_parameter.py +++ b/nipyapi/nifi/models/client_id_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClientIdParameter(object): """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index e611e77a..3a905b6f 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClusterDTO(object): """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index dbb7dd8c..60ccaaea 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClusterEntity(object): """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index 23ee5987..148e07ab 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClusterSearchResultsEntity(object): """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index fb4f8908..7dc44171 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClusterSummaryDTO(object): """ diff --git a/nipyapi/nifi/models/cluster_summary_entity.py b/nipyapi/nifi/models/cluster_summary_entity.py index 3893b40d..242583aa 100644 --- a/nipyapi/nifi/models/cluster_summary_entity.py +++ b/nipyapi/nifi/models/cluster_summary_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClusterSummaryEntity(object): """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index cea59539..022fd48d 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentDetailsDTO(object): """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index e2c76e4d..7bbe6162 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentDifferenceDTO(object): """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index 96838ea1..b11abbae 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentHistoryDTO(object): """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 58a7a80a..fda3a4db 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentHistoryEntity(object): """ diff --git a/nipyapi/nifi/models/component_manifest.py b/nipyapi/nifi/models/component_manifest.py index 883e86db..d9c1f39f 100644 --- a/nipyapi/nifi/models/component_manifest.py +++ b/nipyapi/nifi/models/component_manifest.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentManifest(object): """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index 7f7db56e..ad10640b 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentReferenceDTO(object): """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 5d8d4504..cb9e29f4 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentReferenceEntity(object): """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index 2199339e..4e7c18cd 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentRestrictionPermissionDTO(object): """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index 592f4f69..b9240b6f 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentSearchResultDTO(object): """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index 8ca4463b..19c8f236 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentStateDTO(object): """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index 8627c5c4..afe21411 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentStateEntity(object): """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py index d7a3d8d6..0f5b7493 100644 --- a/nipyapi/nifi/models/component_validation_result_dto.py +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentValidationResultDTO(object): """ @@ -222,12 +224,13 @@ def reference_type(self, reference_type): :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", "STATELESS_GROUP", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP", ] + 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 diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py index fa03d692..fa626208 100644 --- a/nipyapi/nifi/models/component_validation_result_entity.py +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentValidationResultEntity(object): """ diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py index 944e71fd..02e6b6e1 100644 --- a/nipyapi/nifi/models/component_validation_results_entity.py +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentValidationResultsEntity(object): """ diff --git a/nipyapi/nifi/models/config_verification_result_dto.py b/nipyapi/nifi/models/config_verification_result_dto.py index 9fb31220..e0d6686f 100644 --- a/nipyapi/nifi/models/config_verification_result_dto.py +++ b/nipyapi/nifi/models/config_verification_result_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigVerificationResultDTO(object): """ @@ -100,12 +102,13 @@ def outcome(self, outcome): :param outcome: The outcome of this ConfigVerificationResultDTO. :type: str """ - allowed_values = ["SUCCESSFUL", "FAILED", "SKIPPED", ] - if outcome not in allowed_values: - raise ValueError( - "Invalid value for `outcome` ({0}), must be one of {1}" - .format(outcome, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["SUCCESSFUL", "FAILED", "SKIPPED", ] + if outcome not in allowed_values: + raise ValueError( + "Invalid value for `outcome` ({0}), must be one of {1}" + .format(outcome, allowed_values) + ) self._outcome = outcome diff --git a/nipyapi/nifi/models/configuration_analysis_dto.py b/nipyapi/nifi/models/configuration_analysis_dto.py index 3235ad80..d8adf889 100644 --- a/nipyapi/nifi/models/configuration_analysis_dto.py +++ b/nipyapi/nifi/models/configuration_analysis_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationAnalysisDTO(object): """ diff --git a/nipyapi/nifi/models/configuration_analysis_entity.py b/nipyapi/nifi/models/configuration_analysis_entity.py index 879c84d5..5c432baf 100644 --- a/nipyapi/nifi/models/configuration_analysis_entity.py +++ b/nipyapi/nifi/models/configuration_analysis_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationAnalysisEntity(object): """ diff --git a/nipyapi/nifi/models/configuration_step.py b/nipyapi/nifi/models/configuration_step.py index a7839b71..acb7684b 100644 --- a/nipyapi/nifi/models/configuration_step.py +++ b/nipyapi/nifi/models/configuration_step.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStep(object): """ diff --git a/nipyapi/nifi/models/configuration_step_configuration_dto.py b/nipyapi/nifi/models/configuration_step_configuration_dto.py index a9f49754..a5da266f 100644 --- a/nipyapi/nifi/models/configuration_step_configuration_dto.py +++ b/nipyapi/nifi/models/configuration_step_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/configuration_step_dependency.py b/nipyapi/nifi/models/configuration_step_dependency.py index e66927e6..4d699eca 100644 --- a/nipyapi/nifi/models/configuration_step_dependency.py +++ b/nipyapi/nifi/models/configuration_step_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepDependency(object): """ diff --git a/nipyapi/nifi/models/configuration_step_dependency_dto.py b/nipyapi/nifi/models/configuration_step_dependency_dto.py index 510a99b6..67ae65f5 100644 --- a/nipyapi/nifi/models/configuration_step_dependency_dto.py +++ b/nipyapi/nifi/models/configuration_step_dependency_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepDependencyDTO(object): """ diff --git a/nipyapi/nifi/models/configuration_step_entity.py b/nipyapi/nifi/models/configuration_step_entity.py index 8bae54ad..2d21ab25 100644 --- a/nipyapi/nifi/models/configuration_step_entity.py +++ b/nipyapi/nifi/models/configuration_step_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepEntity(object): """ diff --git a/nipyapi/nifi/models/configuration_step_names_entity.py b/nipyapi/nifi/models/configuration_step_names_entity.py index dbc4ff9e..d78fb5d0 100644 --- a/nipyapi/nifi/models/configuration_step_names_entity.py +++ b/nipyapi/nifi/models/configuration_step_names_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepNamesEntity(object): """ diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index bf58a13f..927a65d6 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectableComponent(object): """ @@ -202,12 +204,13 @@ def type(self, type): :param type: The type of this ConnectableComponent. :type: str """ - allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] + 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 diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index 534945b5..39d53b53 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectableDTO(object): """ @@ -266,12 +268,13 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] + 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 diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index 2bc547e0..c690f68b 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionDTO(object): """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index 2ac238e0..8f71c2b2 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionEntity(object): """ @@ -260,12 +262,13 @@ def destination_type(self, destination_type): """ if destination_type is None: raise ValueError("Invalid value for `destination_type`, must not be `None`") - allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] - if destination_type not in allowed_values: - raise ValueError( - "Invalid value for `destination_type` ({0}), must be one of {1}" - .format(destination_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] + if destination_type not in allowed_values: + raise ValueError( + "Invalid value for `destination_type` ({0}), must be one of {1}" + .format(destination_type, allowed_values) + ) self._destination_type = destination_type @@ -492,12 +495,13 @@ def source_type(self, source_type): """ if source_type is None: raise ValueError("Invalid value for `source_type`, must not be `None`") - allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] - if source_type not in allowed_values: - raise ValueError( - "Invalid value for `source_type` ({0}), must be one of {1}" - .format(source_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] + if source_type not in allowed_values: + raise ValueError( + "Invalid value for `source_type` ({0}), must be one of {1}" + .format(source_type, allowed_values) + ) self._source_type = source_type diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py index e5429427..a375f37d 100644 --- a/nipyapi/nifi/models/connection_statistics_dto.py +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatisticsDTO(object): """ diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py index 475e3e19..81e8e38e 100644 --- a/nipyapi/nifi/models/connection_statistics_entity.py +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatisticsEntity(object): """ diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py index 3d7f5b4d..5ea9d58e 100644 --- a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatisticsSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index c9853387..caa6703a 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatusDTO(object): """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index 9f183fe4..d4dcc94a 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatusEntity(object): """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py index 84b6d371..8c04b26e 100644 --- a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatusPredictionsSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 9052a5b1..9bd76982 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatusSnapshotDTO(object): """ @@ -448,12 +450,13 @@ def load_balance_status(self, load_balance_status): :param load_balance_status: The load_balance_status of this ConnectionStatusSnapshotDTO. :type: str """ - allowed_values = ["LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_ACTIVE", "LOAD_BALANCE_INACTIVE", ] - if load_balance_status not in allowed_values: - raise ValueError( - "Invalid value for `load_balance_status` ({0}), must be one of {1}" - .format(load_balance_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_ACTIVE", "LOAD_BALANCE_INACTIVE", ] + if load_balance_status not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_status` ({0}), must be one of {1}" + .format(load_balance_status, allowed_values) + ) self._load_balance_status = load_balance_status diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 6d0ea267..a88c7ae4 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionStatusSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index 501abdb3..fecf5483 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectionsEntity(object): """ diff --git a/nipyapi/nifi/models/connector_action_dto.py b/nipyapi/nifi/models/connector_action_dto.py index 5b321188..47dd3378 100644 --- a/nipyapi/nifi/models/connector_action_dto.py +++ b/nipyapi/nifi/models/connector_action_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorActionDTO(object): """ diff --git a/nipyapi/nifi/models/connector_configuration_dto.py b/nipyapi/nifi/models/connector_configuration_dto.py index b74cf6df..55e8ef97 100644 --- a/nipyapi/nifi/models/connector_configuration_dto.py +++ b/nipyapi/nifi/models/connector_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/connector_definition.py b/nipyapi/nifi/models/connector_definition.py index d2602d35..e0b4aad1 100644 --- a/nipyapi/nifi/models/connector_definition.py +++ b/nipyapi/nifi/models/connector_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorDefinition(object): """ diff --git a/nipyapi/nifi/models/connector_dto.py b/nipyapi/nifi/models/connector_dto.py index e9b88ae9..ed078212 100644 --- a/nipyapi/nifi/models/connector_dto.py +++ b/nipyapi/nifi/models/connector_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorDTO(object): """ @@ -417,12 +419,13 @@ def state(self, state): :param state: The state of this ConnectorDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/connector_entity.py b/nipyapi/nifi/models/connector_entity.py index 5ca07231..d1f56899 100644 --- a/nipyapi/nifi/models/connector_entity.py +++ b/nipyapi/nifi/models/connector_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorEntity(object): """ diff --git a/nipyapi/nifi/models/connector_property_allowable_values_entity.py b/nipyapi/nifi/models/connector_property_allowable_values_entity.py index 2a7ab33b..c475791a 100644 --- a/nipyapi/nifi/models/connector_property_allowable_values_entity.py +++ b/nipyapi/nifi/models/connector_property_allowable_values_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyAllowableValuesEntity(object): """ diff --git a/nipyapi/nifi/models/connector_property_dependency.py b/nipyapi/nifi/models/connector_property_dependency.py index 7a083bd1..a4dc1981 100644 --- a/nipyapi/nifi/models/connector_property_dependency.py +++ b/nipyapi/nifi/models/connector_property_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyDependency(object): """ diff --git a/nipyapi/nifi/models/connector_property_dependency_dto.py b/nipyapi/nifi/models/connector_property_dependency_dto.py index ff64eaed..6bcfd1a9 100644 --- a/nipyapi/nifi/models/connector_property_dependency_dto.py +++ b/nipyapi/nifi/models/connector_property_dependency_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyDependencyDTO(object): """ diff --git a/nipyapi/nifi/models/connector_property_descriptor.py b/nipyapi/nifi/models/connector_property_descriptor.py index 65c8a991..0035c0da 100644 --- a/nipyapi/nifi/models/connector_property_descriptor.py +++ b/nipyapi/nifi/models/connector_property_descriptor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyDescriptor(object): """ @@ -235,12 +237,13 @@ def property_type(self, property_type): :param property_type: The property_type of this ConnectorPropertyDescriptor. :type: str """ - allowed_values = ["STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST", ] - if property_type not in allowed_values: - raise ValueError( - "Invalid value for `property_type` ({0}), must be one of {1}" - .format(property_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST", ] + if property_type not in allowed_values: + raise ValueError( + "Invalid value for `property_type` ({0}), must be one of {1}" + .format(property_type, allowed_values) + ) self._property_type = property_type diff --git a/nipyapi/nifi/models/connector_property_descriptor_dto.py b/nipyapi/nifi/models/connector_property_descriptor_dto.py index 30dffc09..349a58ff 100644 --- a/nipyapi/nifi/models/connector_property_descriptor_dto.py +++ b/nipyapi/nifi/models/connector_property_descriptor_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyDescriptorDTO(object): """ diff --git a/nipyapi/nifi/models/connector_property_group.py b/nipyapi/nifi/models/connector_property_group.py index b1d31d48..8ce7c4b1 100644 --- a/nipyapi/nifi/models/connector_property_group.py +++ b/nipyapi/nifi/models/connector_property_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyGroup(object): """ diff --git a/nipyapi/nifi/models/connector_run_status_entity.py b/nipyapi/nifi/models/connector_run_status_entity.py index 1f3a4e36..e9dea9d2 100644 --- a/nipyapi/nifi/models/connector_run_status_entity.py +++ b/nipyapi/nifi/models/connector_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this ConnectorRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/connector_status_dto.py b/nipyapi/nifi/models/connector_status_dto.py index f566f0a1..e4ad4a08 100644 --- a/nipyapi/nifi/models/connector_status_dto.py +++ b/nipyapi/nifi/models/connector_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorStatusDTO(object): """ @@ -284,12 +286,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ConnectorStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/connector_status_snapshot_dto.py b/nipyapi/nifi/models/connector_status_snapshot_dto.py index cc005025..3a5d2c17 100644 --- a/nipyapi/nifi/models/connector_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connector_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorStatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/connector_types_entity.py b/nipyapi/nifi/models/connector_types_entity.py index acf9fd4f..19d95422 100644 --- a/nipyapi/nifi/models/connector_types_entity.py +++ b/nipyapi/nifi/models/connector_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorTypesEntity(object): """ diff --git a/nipyapi/nifi/models/connector_value_reference_dto.py b/nipyapi/nifi/models/connector_value_reference_dto.py index 2131474e..698ccaef 100644 --- a/nipyapi/nifi/models/connector_value_reference_dto.py +++ b/nipyapi/nifi/models/connector_value_reference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorValueReferenceDTO(object): """ diff --git a/nipyapi/nifi/models/connectors_entity.py b/nipyapi/nifi/models/connectors_entity.py index 86a0feeb..44e3ebed 100644 --- a/nipyapi/nifi/models/connectors_entity.py +++ b/nipyapi/nifi/models/connectors_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorsEntity(object): """ diff --git a/nipyapi/nifi/models/content_viewer_dto.py b/nipyapi/nifi/models/content_viewer_dto.py index 58cf6edd..141c4f4b 100644 --- a/nipyapi/nifi/models/content_viewer_dto.py +++ b/nipyapi/nifi/models/content_viewer_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ContentViewerDTO(object): """ diff --git a/nipyapi/nifi/models/content_viewer_entity.py b/nipyapi/nifi/models/content_viewer_entity.py index e3fa72fb..0e99f626 100644 --- a/nipyapi/nifi/models/content_viewer_entity.py +++ b/nipyapi/nifi/models/content_viewer_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ContentViewerEntity(object): """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index 8282ffb4..a98ed845 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerBulletinsEntity(object): """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 32f56dbb..12621072 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index 31496bbe..264e4541 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerConfigurationEntity(object): """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index c970423c..748a250c 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerDTO(object): """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 35192ea7..5b7a8fed 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerEntity(object): """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index d9c5ebdc..5b9b10be 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceAPI(object): """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index 238987fe..955c20ee 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceApiDTO(object): """ diff --git a/nipyapi/nifi/models/controller_service_definition.py b/nipyapi/nifi/models/controller_service_definition.py index 5ceb3895..a76f6aa1 100644 --- a/nipyapi/nifi/models/controller_service_definition.py +++ b/nipyapi/nifi/models/controller_service_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceDefinition(object): """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 4cfc8b13..9a22e79e 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceDTO(object): """ @@ -302,7 +304,7 @@ def custom_ui_url(self, custom_ui_url): def deprecated(self): """ Gets the deprecated of this ControllerServiceDTO. - Whether the ontroller service has been deprecated. + Whether the controller service has been deprecated. :return: The deprecated of this ControllerServiceDTO. :rtype: bool @@ -313,7 +315,7 @@ def deprecated(self): def deprecated(self, deprecated): """ Sets the deprecated of this ControllerServiceDTO. - Whether the ontroller service has been deprecated. + Whether the controller service has been deprecated. :param deprecated: The deprecated of this ControllerServiceDTO. :type: bool @@ -615,12 +617,13 @@ def state(self, state): :param state: The state of this ControllerServiceDTO. :type: str """ - allowed_values = ["ENABLED", "ENABLING", "DISABLED", "DISABLING", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "ENABLING", "DISABLED", "DISABLING", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state @@ -713,12 +716,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ControllerServiceDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index d26d5328..eecbc421 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceEntity(object): """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index b8611fa4..b7b7946a 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceReferencingComponentDTO(object): """ @@ -278,12 +280,13 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this ControllerServiceReferencingComponentDTO. :type: str """ - allowed_values = ["Processor", "ControllerService", "ReportingTask", "FlowRegistryClient", "ParameterProvider", "FlowAnalysisRule", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["Processor", "ControllerService", "ReportingTask", "FlowRegistryClient", "ParameterProvider", "FlowAnalysisRule", ] + 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 diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index bab0fde0..337beaeb 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceReferencingComponentEntity(object): """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index b4b49465..1b81fec6 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceReferencingComponentsEntity(object): """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index 7fa8dd05..d175f079 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceRunStatusEntity(object): """ @@ -121,12 +123,13 @@ def state(self, state): :param state: The state of this ControllerServiceRunStatusEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index e96b5b65..1030e9b1 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceStatusDTO(object): """ @@ -95,12 +97,13 @@ def run_status(self, run_status): :param run_status: The run_status of this ControllerServiceStatusDTO. :type: str """ - allowed_values = ["ENABLED", "ENABLING", "DISABLED", "DISABLING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "ENABLING", "DISABLED", "DISABLING", ] + 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 @@ -124,12 +127,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ControllerServiceStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index c151dd46..e32ca191 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceTypesEntity(object): """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index 6b77a2f7..5eec46ae 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServicesEntity(object): """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index d85cf458..84d5c64d 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerStatusDTO(object): """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index ae041fc7..6427919f 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerStatusEntity(object): """ diff --git a/nipyapi/nifi/models/copy_request_entity.py b/nipyapi/nifi/models/copy_request_entity.py index b2928ec6..a45bcc73 100644 --- a/nipyapi/nifi/models/copy_request_entity.py +++ b/nipyapi/nifi/models/copy_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CopyRequestEntity(object): """ diff --git a/nipyapi/nifi/models/copy_response_entity.py b/nipyapi/nifi/models/copy_response_entity.py index be17b37f..6b61cc4a 100644 --- a/nipyapi/nifi/models/copy_response_entity.py +++ b/nipyapi/nifi/models/copy_response_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CopyResponseEntity(object): """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index db3c26b1..c9f80967 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CopySnippetRequestEntity(object): """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index 1a30290f..43b96168 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CounterDTO(object): """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index a60ddcb9..2ff1c621 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CounterEntity(object): """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index 5c3c2e8d..4ca0f787 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CountersDTO(object): """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index 11c1ca73..244e607a 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CountersEntity(object): """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index 1ac4fed0..f8defad0 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CountersSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 943d49e5..843886b0 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CreateActiveRequestEntity(object): """ diff --git a/nipyapi/nifi/models/create_flow_branch_request_entity.py b/nipyapi/nifi/models/create_flow_branch_request_entity.py index a49a4295..15023d8b 100644 --- a/nipyapi/nifi/models/create_flow_branch_request_entity.py +++ b/nipyapi/nifi/models/create_flow_branch_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CreateFlowBranchRequestEntity(object): """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index 189ab85c..4f4f33be 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CurrentUserEntity(object): """ diff --git a/nipyapi/nifi/models/date_time_parameter.py b/nipyapi/nifi/models/date_time_parameter.py index 7fc35e03..5ffbe2d3 100644 --- a/nipyapi/nifi/models/date_time_parameter.py +++ b/nipyapi/nifi/models/date_time_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DateTimeParameter(object): """ diff --git a/nipyapi/nifi/models/defined_type.py b/nipyapi/nifi/models/defined_type.py index 8f4efb7c..edebb451 100644 --- a/nipyapi/nifi/models/defined_type.py +++ b/nipyapi/nifi/models/defined_type.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DefinedType(object): """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 6bfc9e2b..5c1fc4cb 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DifferenceDTO(object): """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index 6228a7c4..61bf976b 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DimensionsDTO(object): """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 5e92485d..794f5212 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DocumentedTypeDTO(object): """ @@ -176,7 +178,7 @@ def description(self, description): def explicit_restrictions(self): """ Gets the explicit_restrictions of this DocumentedTypeDTO. - An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored. + An optional collection of explicit restrictions. If specified, these explicit restrictions will be enforced. :return: The explicit_restrictions of this DocumentedTypeDTO. :rtype: list[ExplicitRestrictionDTO] @@ -187,7 +189,7 @@ def explicit_restrictions(self): def explicit_restrictions(self, explicit_restrictions): """ Sets the explicit_restrictions of this DocumentedTypeDTO. - An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored. + An optional collection of explicit restrictions. If specified, these explicit restrictions will be enforced. :param explicit_restrictions: The explicit_restrictions of this DocumentedTypeDTO. :type: list[ExplicitRestrictionDTO] diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index 17c5ba3f..cce1f8e1 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DropRequestDTO(object): """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index 9789660d..ec43b72b 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DropRequestEntity(object): """ diff --git a/nipyapi/nifi/models/dynamic_property.py b/nipyapi/nifi/models/dynamic_property.py index 5f9fc96f..b2276628 100644 --- a/nipyapi/nifi/models/dynamic_property.py +++ b/nipyapi/nifi/models/dynamic_property.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DynamicProperty(object): """ @@ -100,12 +102,13 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this DynamicProperty. :type: str """ - allowed_values = ["NONE", "ENVIRONMENT", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["NONE", "ENVIRONMENT", "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 diff --git a/nipyapi/nifi/models/dynamic_relationship.py b/nipyapi/nifi/models/dynamic_relationship.py index eeceba7d..b00f31c6 100644 --- a/nipyapi/nifi/models/dynamic_relationship.py +++ b/nipyapi/nifi/models/dynamic_relationship.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DynamicRelationship(object): """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 7e6e3695..9e83157e 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExplicitRestrictionDTO(object): """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py index 029bec00..1a26cdc7 100644 --- a/nipyapi/nifi/models/external_controller_service_reference.py +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExternalControllerServiceReference(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_result_entity.py b/nipyapi/nifi/models/flow_analysis_result_entity.py index 53678d44..80e0dcec 100644 --- a/nipyapi/nifi/models/flow_analysis_result_entity.py +++ b/nipyapi/nifi/models/flow_analysis_result_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisResultEntity(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_rule_definition.py b/nipyapi/nifi/models/flow_analysis_rule_definition.py index 1fb8ca5d..942c1c04 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_definition.py +++ b/nipyapi/nifi/models/flow_analysis_rule_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleDefinition(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_rule_dto.py b/nipyapi/nifi/models/flow_analysis_rule_dto.py index 285eb09b..598c81ab 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_dto.py +++ b/nipyapi/nifi/models/flow_analysis_rule_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleDTO(object): """ @@ -503,12 +505,13 @@ def state(self, state): :param state: The state of this FlowAnalysisRuleDTO. :type: str """ - allowed_values = ["ENABLED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state @@ -601,12 +604,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this FlowAnalysisRuleDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/flow_analysis_rule_entity.py b/nipyapi/nifi/models/flow_analysis_rule_entity.py index a9bd591c..03a8625d 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleEntity(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py b/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py index 52405192..0e9d5142 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this FlowAnalysisRuleRunStatusEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/flow_analysis_rule_status_dto.py b/nipyapi/nifi/models/flow_analysis_rule_status_dto.py index 5ce765ec..9298fc3e 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_status_dto.py +++ b/nipyapi/nifi/models/flow_analysis_rule_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleStatusDTO(object): """ @@ -95,12 +97,13 @@ def run_status(self, run_status): :param run_status: The run_status of this FlowAnalysisRuleStatusDTO. :type: str """ - allowed_values = ["ENABLED", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "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 @@ -124,12 +127,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this FlowAnalysisRuleStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/flow_analysis_rule_types_entity.py b/nipyapi/nifi/models/flow_analysis_rule_types_entity.py index 3803b119..39c743f5 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_types_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rule_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleTypesEntity(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py b/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py index 6f041c14..b6a505e3 100644 --- a/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py +++ b/nipyapi/nifi/models/flow_analysis_rule_violation_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRuleViolationDTO(object): """ diff --git a/nipyapi/nifi/models/flow_analysis_rules_entity.py b/nipyapi/nifi/models/flow_analysis_rules_entity.py index f9cc14d3..cb06c3f7 100644 --- a/nipyapi/nifi/models/flow_analysis_rules_entity.py +++ b/nipyapi/nifi/models/flow_analysis_rules_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowAnalysisRulesEntity(object): """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 6dff8c80..6077d544 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowBreadcrumbDTO(object): """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index ab704309..aad09fb8 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowBreadcrumbEntity(object): """ @@ -168,12 +170,13 @@ def versioned_flow_state(self, versioned_flow_state): :param versioned_flow_state: The versioned_flow_state of this FlowBreadcrumbEntity. :type: str """ - allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] - if versioned_flow_state not in allowed_values: - raise ValueError( - "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" - .format(versioned_flow_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] + if versioned_flow_state not in allowed_values: + raise ValueError( + "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" + .format(versioned_flow_state, allowed_values) + ) self._versioned_flow_state = versioned_flow_state diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 92be5dae..04b2a616 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowComparisonEntity(object): """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index 97fc5ecc..7a9fecfe 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index ea1c1b66..b8b45c29 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowConfigurationEntity(object): """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index b12c7dd7..d7155566 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowDTO(object): """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index 0ca7d723..ed3d62fc 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowEntity(object): """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index 00e8e495..25fafa80 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowFileDTO(object): """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index ac7265de..0789238b 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowFileEntity(object): """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index f81ade76..7ab4bde1 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowFileSummaryDTO(object): """ diff --git a/nipyapi/nifi/models/flow_registry_branch_dto.py b/nipyapi/nifi/models/flow_registry_branch_dto.py index 7f127051..3d245e7a 100644 --- a/nipyapi/nifi/models/flow_registry_branch_dto.py +++ b/nipyapi/nifi/models/flow_registry_branch_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBranchDTO(object): """ diff --git a/nipyapi/nifi/models/flow_registry_branch_entity.py b/nipyapi/nifi/models/flow_registry_branch_entity.py index 6e0d87e4..8e743c01 100644 --- a/nipyapi/nifi/models/flow_registry_branch_entity.py +++ b/nipyapi/nifi/models/flow_registry_branch_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBranchEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_branches_entity.py b/nipyapi/nifi/models/flow_registry_branches_entity.py index c237372f..60f6a268 100644 --- a/nipyapi/nifi/models/flow_registry_branches_entity.py +++ b/nipyapi/nifi/models/flow_registry_branches_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBranchesEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_bucket.py b/nipyapi/nifi/models/flow_registry_bucket.py index f6d27ed5..b326fb01 100644 --- a/nipyapi/nifi/models/flow_registry_bucket.py +++ b/nipyapi/nifi/models/flow_registry_bucket.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBucket(object): """ diff --git a/nipyapi/nifi/models/flow_registry_bucket_dto.py b/nipyapi/nifi/models/flow_registry_bucket_dto.py index 01c17837..28c3a36f 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_dto.py +++ b/nipyapi/nifi/models/flow_registry_bucket_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBucketDTO(object): """ diff --git a/nipyapi/nifi/models/flow_registry_bucket_entity.py b/nipyapi/nifi/models/flow_registry_bucket_entity.py index 8609b86d..0b43cc81 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_entity.py +++ b/nipyapi/nifi/models/flow_registry_bucket_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBucketEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_buckets_entity.py b/nipyapi/nifi/models/flow_registry_buckets_entity.py index f8916016..b9b4c0a7 100644 --- a/nipyapi/nifi/models/flow_registry_buckets_entity.py +++ b/nipyapi/nifi/models/flow_registry_buckets_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryBucketsEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_client_definition.py b/nipyapi/nifi/models/flow_registry_client_definition.py index 3bea31a4..ae09067b 100644 --- a/nipyapi/nifi/models/flow_registry_client_definition.py +++ b/nipyapi/nifi/models/flow_registry_client_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryClientDefinition(object): """ diff --git a/nipyapi/nifi/models/flow_registry_client_dto.py b/nipyapi/nifi/models/flow_registry_client_dto.py index e58df662..2843fb0f 100644 --- a/nipyapi/nifi/models/flow_registry_client_dto.py +++ b/nipyapi/nifi/models/flow_registry_client_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryClientDTO(object): """ @@ -508,12 +510,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this FlowRegistryClientDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/flow_registry_client_entity.py b/nipyapi/nifi/models/flow_registry_client_entity.py index d3e88654..b7b2942c 100644 --- a/nipyapi/nifi/models/flow_registry_client_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryClientEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_client_types_entity.py b/nipyapi/nifi/models/flow_registry_client_types_entity.py index 55153fbe..8f7aec10 100644 --- a/nipyapi/nifi/models/flow_registry_client_types_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryClientTypesEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_clients_entity.py b/nipyapi/nifi/models/flow_registry_clients_entity.py index 2a742fa3..ce3bd578 100644 --- a/nipyapi/nifi/models/flow_registry_clients_entity.py +++ b/nipyapi/nifi/models/flow_registry_clients_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryClientsEntity(object): """ diff --git a/nipyapi/nifi/models/flow_registry_permissions.py b/nipyapi/nifi/models/flow_registry_permissions.py index 90720cf4..ec290599 100644 --- a/nipyapi/nifi/models/flow_registry_permissions.py +++ b/nipyapi/nifi/models/flow_registry_permissions.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowRegistryPermissions(object): """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 418da9c7..2e735141 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FlowSnippetDTO(object): """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index 8476a9fa..78b25ffc 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FunnelDTO(object): """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index 7b89650a..c88111ef 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FunnelEntity(object): """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 99ec6837..1f40f1f9 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FunnelsEntity(object): """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index a805f9a8..2543e5ca 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class GarbageCollectionDTO(object): """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 609ec89c..fffd3b97 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class HistoryDTO(object): """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index a4a70c57..9fc7ee63 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class HistoryEntity(object): """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index 0ebdf4c4..2d394beb 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class InputPortsEntity(object): """ diff --git a/nipyapi/nifi/models/integer_parameter.py b/nipyapi/nifi/models/integer_parameter.py index 571f0384..ddc57468 100644 --- a/nipyapi/nifi/models/integer_parameter.py +++ b/nipyapi/nifi/models/integer_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class IntegerParameter(object): """ diff --git a/nipyapi/nifi/models/jmx_metrics_result_dto.py b/nipyapi/nifi/models/jmx_metrics_result_dto.py index e33fcb35..3e2c3bbf 100644 --- a/nipyapi/nifi/models/jmx_metrics_result_dto.py +++ b/nipyapi/nifi/models/jmx_metrics_result_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class JmxMetricsResultDTO(object): """ diff --git a/nipyapi/nifi/models/jmx_metrics_results_entity.py b/nipyapi/nifi/models/jmx_metrics_results_entity.py index d9580fcd..6b1a9275 100644 --- a/nipyapi/nifi/models/jmx_metrics_results_entity.py +++ b/nipyapi/nifi/models/jmx_metrics_results_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class JmxMetricsResultsEntity(object): """ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index b3271558..a45025b8 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LabelDTO(object): """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index 652bccd9..7e55f370 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LabelEntity(object): """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index a429a029..f0cc28ac 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LabelsEntity(object): """ diff --git a/nipyapi/nifi/models/latest_provenance_events_dto.py b/nipyapi/nifi/models/latest_provenance_events_dto.py index f448eedd..3f8301a1 100644 --- a/nipyapi/nifi/models/latest_provenance_events_dto.py +++ b/nipyapi/nifi/models/latest_provenance_events_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LatestProvenanceEventsDTO(object): """ diff --git a/nipyapi/nifi/models/latest_provenance_events_entity.py b/nipyapi/nifi/models/latest_provenance_events_entity.py index 16c501ad..0cee0d39 100644 --- a/nipyapi/nifi/models/latest_provenance_events_entity.py +++ b/nipyapi/nifi/models/latest_provenance_events_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LatestProvenanceEventsEntity(object): """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 855aaa0f..23b0815d 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LineageDTO(object): """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index 3fd1a62b..babe1554 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LineageEntity(object): """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index e6ad2cd1..30e5d06b 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LineageRequestDTO(object): """ @@ -123,12 +125,13 @@ def lineage_request_type(self, lineage_request_type): :param lineage_request_type: The lineage_request_type of this LineageRequestDTO. :type: str """ - allowed_values = ["PARENTS", "CHILDREN", "FLOWFILE", ] - if lineage_request_type not in allowed_values: - raise ValueError( - "Invalid value for `lineage_request_type` ({0}), must be one of {1}" - .format(lineage_request_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PARENTS", "CHILDREN", "FLOWFILE", ] + if lineage_request_type not in allowed_values: + raise ValueError( + "Invalid value for `lineage_request_type` ({0}), must be one of {1}" + .format(lineage_request_type, allowed_values) + ) self._lineage_request_type = lineage_request_type diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index 7b7dfe5e..dc90de3a 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LineageResultsDTO(object): """ diff --git a/nipyapi/nifi/models/listen_port_dto.py b/nipyapi/nifi/models/listen_port_dto.py index c4082b86..36840484 100644 --- a/nipyapi/nifi/models/listen_port_dto.py +++ b/nipyapi/nifi/models/listen_port_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ListenPortDTO(object): """ diff --git a/nipyapi/nifi/models/listen_ports_entity.py b/nipyapi/nifi/models/listen_ports_entity.py index 65c65e19..91f3c959 100644 --- a/nipyapi/nifi/models/listen_ports_entity.py +++ b/nipyapi/nifi/models/listen_ports_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ListenPortsEntity(object): """ diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 1bf021c3..02c9b37d 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ListingRequestDTO(object): """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index f7e5a03e..6ec3ed06 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ListingRequestEntity(object): """ diff --git a/nipyapi/nifi/models/long_parameter.py b/nipyapi/nifi/models/long_parameter.py index 579d6814..daa8b9df 100644 --- a/nipyapi/nifi/models/long_parameter.py +++ b/nipyapi/nifi/models/long_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LongParameter(object): """ diff --git a/nipyapi/nifi/models/migration_payload_dto.py b/nipyapi/nifi/models/migration_payload_dto.py new file mode 100644 index 00000000..e26e3f1f --- /dev/null +++ b/nipyapi/nifi/models/migration_payload_dto.py @@ -0,0 +1,121 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationPayloadDTO(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 = { + 'payload_id': 'str' } + + attribute_map = { + 'payload_id': 'payloadId' } + + def __init__(self, payload_id=None): + """ + MigrationPayloadDTO - a model defined in Swagger + """ + + self._payload_id = None + + if payload_id is not None: + self.payload_id = payload_id + + @property + def payload_id(self): + """ + Gets the payload_id of this MigrationPayloadDTO. + The identifier of the uploaded migration payload. + + :return: The payload_id of this MigrationPayloadDTO. + :rtype: str + """ + return self._payload_id + + @payload_id.setter + def payload_id(self, payload_id): + """ + Sets the payload_id of this MigrationPayloadDTO. + The identifier of the uploaded migration payload. + + :param payload_id: The payload_id of this MigrationPayloadDTO. + :type: str + """ + + self._payload_id = payload_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationPayloadDTO): + 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/migration_payload_entity.py b/nipyapi/nifi/models/migration_payload_entity.py new file mode 100644 index 00000000..3bd868fb --- /dev/null +++ b/nipyapi/nifi/models/migration_payload_entity.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationPayloadEntity(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 = { + 'payload': 'MigrationPayloadDTO' } + + attribute_map = { + 'payload': 'payload' } + + def __init__(self, payload=None): + """ + MigrationPayloadEntity - a model defined in Swagger + """ + + self._payload = None + + if payload is not None: + self.payload = payload + + @property + def payload(self): + """ + Gets the payload of this MigrationPayloadEntity. + + :return: The payload of this MigrationPayloadEntity. + :rtype: MigrationPayloadDTO + """ + return self._payload + + @payload.setter + def payload(self, payload): + """ + Sets the payload of this MigrationPayloadEntity. + + :param payload: The payload of this MigrationPayloadEntity. + :type: MigrationPayloadDTO + """ + + self._payload = payload + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationPayloadEntity): + 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/migration_request_dto.py b/nipyapi/nifi/models/migration_request_dto.py new file mode 100644 index 00000000..2b1f7430 --- /dev/null +++ b/nipyapi/nifi/models/migration_request_dto.py @@ -0,0 +1,427 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationRequestDTO(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 = { + 'complete': 'bool', +'connector_id': 'str', +'failure_reason': 'str', +'last_updated': 'datetime', +'local_source': 'MigrationRequestLocalSourceDTO', +'payload_id': 'str', +'percent_completed': 'int', +'request_id': 'str', +'state': 'str', +'submission_time': 'datetime', +'update_steps': 'list[MigrationUpdateStepDTO]', +'uri': 'str' } + + attribute_map = { + 'complete': 'complete', +'connector_id': 'connectorId', +'failure_reason': 'failureReason', +'last_updated': 'lastUpdated', +'local_source': 'localSource', +'payload_id': 'payloadId', +'percent_completed': 'percentCompleted', +'request_id': 'requestId', +'state': 'state', +'submission_time': 'submissionTime', +'update_steps': 'updateSteps', +'uri': 'uri' } + + def __init__(self, complete=None, connector_id=None, failure_reason=None, last_updated=None, local_source=None, payload_id=None, percent_completed=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None): + """ + MigrationRequestDTO - a model defined in Swagger + """ + + self._complete = None + self._connector_id = None + self._failure_reason = None + self._last_updated = None + self._local_source = None + self._payload_id = None + self._percent_completed = None + self._request_id = None + self._state = None + self._submission_time = None + self._update_steps = None + self._uri = None + + if complete is not None: + self.complete = complete + if connector_id is not None: + self.connector_id = connector_id + if failure_reason is not None: + self.failure_reason = failure_reason + if last_updated is not None: + self.last_updated = last_updated + if local_source is not None: + self.local_source = local_source + if payload_id is not None: + self.payload_id = payload_id + if percent_completed is not None: + self.percent_completed = percent_completed + if request_id is not None: + self.request_id = request_id + if state is not None: + self.state = state + if submission_time is not None: + self.submission_time = submission_time + if update_steps is not None: + self.update_steps = update_steps + if uri is not None: + self.uri = uri + + @property + def complete(self): + """ + Gets the complete of this MigrationRequestDTO. + Whether or not the request is completed + + :return: The complete of this MigrationRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this MigrationRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this MigrationRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def connector_id(self): + """ + Gets the connector_id of this MigrationRequestDTO. + The identifier of the Connector receiving the migration. + + :return: The connector_id of this MigrationRequestDTO. + :rtype: str + """ + return self._connector_id + + @connector_id.setter + def connector_id(self, connector_id): + """ + Sets the connector_id of this MigrationRequestDTO. + The identifier of the Connector receiving the migration. + + :param connector_id: The connector_id of this MigrationRequestDTO. + :type: str + """ + + self._connector_id = connector_id + + @property + def failure_reason(self): + """ + Gets the failure_reason of this MigrationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this MigrationRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this MigrationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this MigrationRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def last_updated(self): + """ + Gets the last_updated of this MigrationRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this MigrationRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this MigrationRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this MigrationRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def local_source(self): + """ + Gets the local_source of this MigrationRequestDTO. + + :return: The local_source of this MigrationRequestDTO. + :rtype: MigrationRequestLocalSourceDTO + """ + return self._local_source + + @local_source.setter + def local_source(self, local_source): + """ + Sets the local_source of this MigrationRequestDTO. + + :param local_source: The local_source of this MigrationRequestDTO. + :type: MigrationRequestLocalSourceDTO + """ + + self._local_source = local_source + + @property + def payload_id(self): + """ + Gets the payload_id of this MigrationRequestDTO. + The identifier of a previously uploaded migration payload. + + :return: The payload_id of this MigrationRequestDTO. + :rtype: str + """ + return self._payload_id + + @payload_id.setter + def payload_id(self, payload_id): + """ + Sets the payload_id of this MigrationRequestDTO. + The identifier of a previously uploaded migration payload. + + :param payload_id: The payload_id of this MigrationRequestDTO. + :type: str + """ + + self._payload_id = payload_id + + @property + def percent_completed(self): + """ + Gets the percent_completed of this MigrationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this MigrationRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this MigrationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this MigrationRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def request_id(self): + """ + Gets the request_id of this MigrationRequestDTO. + The ID of the request + + :return: The request_id of this MigrationRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this MigrationRequestDTO. + The ID of the request + + :param request_id: The request_id of this MigrationRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def state(self): + """ + Gets the state of this MigrationRequestDTO. + A description of the current state of the request + + :return: The state of this MigrationRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this MigrationRequestDTO. + A description of the current state of the request + + :param state: The state of this MigrationRequestDTO. + :type: str + """ + + self._state = state + + @property + def submission_time(self): + """ + Gets the submission_time of this MigrationRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this MigrationRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this MigrationRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this MigrationRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def update_steps(self): + """ + Gets the update_steps of this MigrationRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this MigrationRequestDTO. + :rtype: list[MigrationUpdateStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this MigrationRequestDTO. + 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 MigrationRequestDTO. + :type: list[MigrationUpdateStepDTO] + """ + + self._update_steps = update_steps + + @property + def uri(self): + """ + Gets the uri of this MigrationRequestDTO. + The URI for the request + + :return: The uri of this MigrationRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this MigrationRequestDTO. + The URI for the request + + :param uri: The uri of this MigrationRequestDTO. + :type: str + """ + + self._uri = uri + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationRequestDTO): + 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/migration_request_entity.py b/nipyapi/nifi/models/migration_request_entity.py new file mode 100644 index 00000000..96f0c978 --- /dev/null +++ b/nipyapi/nifi/models/migration_request_entity.py @@ -0,0 +1,119 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationRequestEntity(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': 'MigrationRequestDTO' } + + attribute_map = { + 'request': 'request' } + + def __init__(self, request=None): + """ + MigrationRequestEntity - a model defined in Swagger + """ + + self._request = None + + if request is not None: + self.request = request + + @property + def request(self): + """ + Gets the request of this MigrationRequestEntity. + + :return: The request of this MigrationRequestEntity. + :rtype: MigrationRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this MigrationRequestEntity. + + :param request: The request of this MigrationRequestEntity. + :type: MigrationRequestDTO + """ + + self._request = request + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationRequestEntity): + 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/migration_request_local_source_dto.py b/nipyapi/nifi/models/migration_request_local_source_dto.py new file mode 100644 index 00000000..bd5f0cc6 --- /dev/null +++ b/nipyapi/nifi/models/migration_request_local_source_dto.py @@ -0,0 +1,121 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationRequestLocalSourceDTO(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' } + + attribute_map = { + 'process_group_id': 'processGroupId' } + + def __init__(self, process_group_id=None): + """ + MigrationRequestLocalSourceDTO - a model defined in Swagger + """ + + self._process_group_id = None + + if process_group_id is not None: + self.process_group_id = process_group_id + + @property + def process_group_id(self): + """ + Gets the process_group_id of this MigrationRequestLocalSourceDTO. + The identifier of the local source Process Group to migrate. + + :return: The process_group_id of this MigrationRequestLocalSourceDTO. + :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 MigrationRequestLocalSourceDTO. + The identifier of the local source Process Group to migrate. + + :param process_group_id: The process_group_id of this MigrationRequestLocalSourceDTO. + :type: str + """ + + self._process_group_id = process_group_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationRequestLocalSourceDTO): + 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/migration_update_step_dto.py b/nipyapi/nifi/models/migration_update_step_dto.py new file mode 100644 index 00000000..cb405889 --- /dev/null +++ b/nipyapi/nifi/models/migration_update_step_dto.py @@ -0,0 +1,177 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class MigrationUpdateStepDTO(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 = { + 'complete': 'bool', +'description': 'str', +'failure_reason': 'str' } + + attribute_map = { + 'complete': 'complete', +'description': 'description', +'failure_reason': 'failureReason' } + + def __init__(self, complete=None, description=None, failure_reason=None): + """ + MigrationUpdateStepDTO - a model defined in Swagger + """ + + self._complete = None + self._description = None + self._failure_reason = None + + if complete is not None: + self.complete = complete + if description is not None: + self.description = description + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def complete(self): + """ + Gets the complete of this MigrationUpdateStepDTO. + Whether or not this step has completed + + :return: The complete of this MigrationUpdateStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this MigrationUpdateStepDTO. + Whether or not this step has completed + + :param complete: The complete of this MigrationUpdateStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def description(self): + """ + Gets the description of this MigrationUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this MigrationUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this MigrationUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this MigrationUpdateStepDTO. + :type: str + """ + + self._description = description + + @property + def failure_reason(self): + """ + Gets the failure_reason of this MigrationUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this MigrationUpdateStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this MigrationUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this MigrationUpdateStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, MigrationUpdateStepDTO): + 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/multi_processor_use_case.py b/nipyapi/nifi/models/multi_processor_use_case.py index 88631208..78c30634 100644 --- a/nipyapi/nifi/models/multi_processor_use_case.py +++ b/nipyapi/nifi/models/multi_processor_use_case.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class MultiProcessorUseCase(object): """ diff --git a/nipyapi/nifi/models/nar_coordinate_dto.py b/nipyapi/nifi/models/nar_coordinate_dto.py index 90aaaf00..c7f4e3e8 100644 --- a/nipyapi/nifi/models/nar_coordinate_dto.py +++ b/nipyapi/nifi/models/nar_coordinate_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NarCoordinateDTO(object): """ diff --git a/nipyapi/nifi/models/nar_details_entity.py b/nipyapi/nifi/models/nar_details_entity.py index 9fc83138..13361745 100644 --- a/nipyapi/nifi/models/nar_details_entity.py +++ b/nipyapi/nifi/models/nar_details_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NarDetailsEntity(object): """ diff --git a/nipyapi/nifi/models/nar_summaries_entity.py b/nipyapi/nifi/models/nar_summaries_entity.py index d6f5fcf5..84e92747 100644 --- a/nipyapi/nifi/models/nar_summaries_entity.py +++ b/nipyapi/nifi/models/nar_summaries_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NarSummariesEntity(object): """ diff --git a/nipyapi/nifi/models/nar_summary_dto.py b/nipyapi/nifi/models/nar_summary_dto.py index d7d45e29..65fc656c 100644 --- a/nipyapi/nifi/models/nar_summary_dto.py +++ b/nipyapi/nifi/models/nar_summary_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NarSummaryDTO(object): """ diff --git a/nipyapi/nifi/models/nar_summary_entity.py b/nipyapi/nifi/models/nar_summary_entity.py index 1cf163b4..3329807b 100644 --- a/nipyapi/nifi/models/nar_summary_entity.py +++ b/nipyapi/nifi/models/nar_summary_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NarSummaryEntity(object): """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py index 124975ee..9372eff9 100644 --- a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeConnectionStatisticsSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 32754839..dec8c895 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeConnectionStatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_connector_status_snapshot_dto.py b/nipyapi/nifi/models/node_connector_status_snapshot_dto.py index 6793ea31..b562f014 100644 --- a/nipyapi/nifi/models/node_connector_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connector_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeConnectorStatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index 661f6d46..58e3748e 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeCountersSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index 27c1f184..9a08317d 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeDTO(object): """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index 6650fc9a..1ddee28e 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeEntity(object): """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index b2a10fc0..ffd0598b 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeEventDTO(object): """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index cd8121dc..c3b21b1f 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodePortStatusSnapshotDTO(object): """ 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 30a827fd..91a8c98c 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeProcessGroupStatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index cf041773..7ff7f88b 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeProcessorStatusSnapshotDTO(object): """ 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 30fba0db..81636de7 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 @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeRemoteProcessGroupStatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py b/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py index 0abedddf..5a3c5d0b 100644 --- a/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeReplayLastEventSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index f16ce8ac..35b84ba0 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeSearchResultDTO(object): """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index bfb2b55d..ee24a0cc 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeStatusSnapshotsDTO(object): """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index e36ec714..49e0ea57 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class NodeSystemDiagnosticsSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 2c18fe8a..2f54f43c 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class OutputPortsEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py index d88df70e..733b5bd6 100644 --- a/nipyapi/nifi/models/parameter_context_dto.py +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py index 546968c7..527b3f25 100644 --- a/nipyapi/nifi/models/parameter_context_entity.py +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py index d5e956b8..0650ec30 100644 --- a/nipyapi/nifi/models/parameter_context_reference_dto.py +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextReferenceDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py index 38a227d1..8441daa4 100644 --- a/nipyapi/nifi/models/parameter_context_reference_entity.py +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextReferenceEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_update_entity.py b/nipyapi/nifi/models/parameter_context_update_entity.py index f4d7b8c7..de0a6ca3 100644 --- a/nipyapi/nifi/models/parameter_context_update_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextUpdateEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py index d2b34101..deadbbdb 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextUpdateRequestDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py index 7b758213..0fcfffff 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextUpdateRequestEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py index a2c633db..e30a1d18 100644 --- a/nipyapi/nifi/models/parameter_context_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextUpdateStepDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py index 9543ad43..36186620 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextValidationRequestDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py index 85efff40..9e2d11a9 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextValidationRequestEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py index 971ce70c..f4664d6a 100644 --- a/nipyapi/nifi/models/parameter_context_validation_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextValidationStepDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py index fb73111a..6adab407 100644 --- a/nipyapi/nifi/models/parameter_contexts_entity.py +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterContextsEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py index 0daf956c..92f2cb76 100644 --- a/nipyapi/nifi/models/parameter_dto.py +++ b/nipyapi/nifi/models/parameter_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py index 7fdffdd5..c2d65c3f 100644 --- a/nipyapi/nifi/models/parameter_entity.py +++ b/nipyapi/nifi/models/parameter_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_group_configuration_entity.py b/nipyapi/nifi/models/parameter_group_configuration_entity.py index c7616bb3..80906841 100644 --- a/nipyapi/nifi/models/parameter_group_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_group_configuration_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterGroupConfigurationEntity(object): """ @@ -123,13 +125,17 @@ def parameter_sensitivities(self, parameter_sensitivities): :param parameter_sensitivities: The parameter_sensitivities of this ParameterGroupConfigurationEntity. :type: dict(str, str) """ - allowed_values = ["SENSITIVE", "NON_SENSITIVE", ] - if not set(parameter_sensitivities.keys()).issubset(set(allowed_values)): - raise ValueError( - "Invalid keys in `parameter_sensitivities` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set(parameter_sensitivities.keys())-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if Configuration().client_side_validation: + allowed_values = ["SENSITIVE", "NON_SENSITIVE", ] + # The enum constrains the map values; keys are free-form names. + # A None value means no choice has been made yet. + invalid = {v for v in (parameter_sensitivities or {}).values() if v is not None} - set(allowed_values) + if invalid: + raise ValueError( + "Invalid values in `parameter_sensitivities` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, invalid)), + ", ".join(map(str, allowed_values))) + ) self._parameter_sensitivities = parameter_sensitivities diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py index 738b6493..eb3235b3 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderApplyParametersRequestDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py index 0a4b3210..41126056 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderApplyParametersRequestEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py index b9f20fd2..6140e136 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderApplyParametersUpdateStepDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_dto.py b/nipyapi/nifi/models/parameter_provider_configuration_dto.py index 04e368fe..5103f2cb 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_dto.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_entity.py b/nipyapi/nifi/models/parameter_provider_configuration_entity.py index 34866682..c84c6c0d 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderConfigurationEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_definition.py b/nipyapi/nifi/models/parameter_provider_definition.py index abe5adc0..fa118216 100644 --- a/nipyapi/nifi/models/parameter_provider_definition.py +++ b/nipyapi/nifi/models/parameter_provider_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderDefinition(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_dto.py b/nipyapi/nifi/models/parameter_provider_dto.py index 5aa39846..e8c4bbfe 100644 --- a/nipyapi/nifi/models/parameter_provider_dto.py +++ b/nipyapi/nifi/models/parameter_provider_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderDTO(object): """ @@ -651,12 +653,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ParameterProviderDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/parameter_provider_entity.py b/nipyapi/nifi/models/parameter_provider_entity.py index 3b5d7f9a..42a8a748 100644 --- a/nipyapi/nifi/models/parameter_provider_entity.py +++ b/nipyapi/nifi/models/parameter_provider_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py index 2bbbf63a..33a3584d 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderParameterApplicationEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py index 7d330007..135fa81c 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderParameterFetchEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_reference.py b/nipyapi/nifi/models/parameter_provider_reference.py index 9f7c96f6..e411dc06 100644 --- a/nipyapi/nifi/models/parameter_provider_reference.py +++ b/nipyapi/nifi/models/parameter_provider_reference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderReference(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py index e5618d40..b6ed05dc 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderReferencingComponentDTO(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py index 232755c3..ffcccbc2 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderReferencingComponentEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py index 945b721d..b8439b55 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderReferencingComponentsEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_provider_types_entity.py b/nipyapi/nifi/models/parameter_provider_types_entity.py index cd35ce92..c5caad88 100644 --- a/nipyapi/nifi/models/parameter_provider_types_entity.py +++ b/nipyapi/nifi/models/parameter_provider_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderTypesEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_providers_entity.py b/nipyapi/nifi/models/parameter_providers_entity.py index d320f7be..9e241686 100644 --- a/nipyapi/nifi/models/parameter_providers_entity.py +++ b/nipyapi/nifi/models/parameter_providers_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProvidersEntity(object): """ diff --git a/nipyapi/nifi/models/parameter_status_dto.py b/nipyapi/nifi/models/parameter_status_dto.py index 7b6ab2b2..3de4288e 100644 --- a/nipyapi/nifi/models/parameter_status_dto.py +++ b/nipyapi/nifi/models/parameter_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterStatusDTO(object): """ @@ -88,12 +90,13 @@ def status(self, status): :param status: The status of this ParameterStatusDTO. :type: str """ - allowed_values = ["NEW", "CHANGED", "REMOVED", "MISSING_BUT_REFERENCED", "UNCHANGED", ] - if status not in allowed_values: - raise ValueError( - "Invalid value for `status` ({0}), must be one of {1}" - .format(status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["NEW", "CHANGED", "REMOVED", "MISSING_BUT_REFERENCED", "UNCHANGED", ] + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" + .format(status, allowed_values) + ) self._status = status diff --git a/nipyapi/nifi/models/paste_request_entity.py b/nipyapi/nifi/models/paste_request_entity.py index fd708de2..4499940b 100644 --- a/nipyapi/nifi/models/paste_request_entity.py +++ b/nipyapi/nifi/models/paste_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PasteRequestEntity(object): """ diff --git a/nipyapi/nifi/models/paste_response_entity.py b/nipyapi/nifi/models/paste_response_entity.py index a9711c22..593d9156 100644 --- a/nipyapi/nifi/models/paste_response_entity.py +++ b/nipyapi/nifi/models/paste_response_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PasteResponseEntity(object): """ diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index 9251711c..b28a346f 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PeerDTO(object): """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index 0afda09a..c4b57c09 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PeersEntity(object): """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index ce505817..5735c4bf 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PermissionsDTO(object): """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index fe3372db..b963c049 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortDTO(object): """ @@ -260,12 +262,13 @@ def port_function(self, port_function): :param port_function: The port_function of this PortDTO. :type: str """ - allowed_values = ["STANDARD", "FAILURE", ] - if port_function not in allowed_values: - raise ValueError( - "Invalid value for `port_function` ({0}), must be one of {1}" - .format(port_function, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STANDARD", "FAILURE", ] + if port_function not in allowed_values: + raise ValueError( + "Invalid value for `port_function` ({0}), must be one of {1}" + .format(port_function, allowed_values) + ) self._port_function = port_function @@ -310,12 +313,13 @@ def state(self, state): :param state: The state of this PortDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state @@ -362,12 +366,13 @@ def type(self, type): :param type: The type of this PortDTO. :type: str """ - allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] + 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 diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index 6155a133..78de4762 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortEntity(object): """ diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index 9c832674..dc60f1b6 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this PortRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index d0da6b0a..68e7cab8 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortStatusDTO(object): """ @@ -210,12 +212,13 @@ def run_status(self, run_status): :param run_status: The run_status of this PortStatusDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] + 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 diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index c62479c7..b75b8934 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortStatusEntity(object): """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index 3a461744..aa131e93 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortStatusSnapshotDTO(object): """ @@ -347,12 +349,13 @@ def run_status(self, run_status): :param run_status: The run_status of this PortStatusSnapshotDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] + 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 diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index 7c626ad6..0a29df8c 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PortStatusSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 7fc83113..f5f373b9 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Position(object): """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index e19d91fd..c814ceba 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PositionDTO(object): """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index 794b22f6..2cc04d84 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PreviousValueDTO(object): """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 470324fe..60940116 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PrioritizerTypesEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index fe639052..1bb2219c 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupDTO(object): """ @@ -396,12 +398,13 @@ def execution_engine(self, execution_engine): :param execution_engine: The execution_engine of this ProcessGroupDTO. :type: str """ - allowed_values = ["STATELESS", "STANDARD", "INHERITED", ] - if execution_engine not in allowed_values: - raise ValueError( - "Invalid value for `execution_engine` ({0}), must be one of {1}" - .format(execution_engine, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STATELESS", "STANDARD", "INHERITED", ] + if execution_engine not in allowed_values: + raise ValueError( + "Invalid value for `execution_engine` ({0}), must be one of {1}" + .format(execution_engine, allowed_values) + ) self._execution_engine = execution_engine @@ -425,12 +428,13 @@ def flowfile_concurrency(self, flowfile_concurrency): :param flowfile_concurrency: The flowfile_concurrency of this ProcessGroupDTO. :type: str """ - allowed_values = ["UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "SINGLE_BATCH_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) - ) + if Configuration().client_side_validation: + allowed_values = ["UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "SINGLE_BATCH_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 @@ -454,12 +458,13 @@ def flowfile_outbound_policy(self, flowfile_outbound_policy): :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) - ) + if Configuration().client_side_validation: + 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 @@ -939,12 +944,13 @@ def stateless_group_scheduled_state(self, stateless_group_scheduled_state): :param stateless_group_scheduled_state: The stateless_group_scheduled_state of this ProcessGroupDTO. :type: str """ - allowed_values = ["STOPPED", "RUNNING", ] - if stateless_group_scheduled_state not in allowed_values: - raise ValueError( - "Invalid value for `stateless_group_scheduled_state` ({0}), must be one of {1}" - .format(stateless_group_scheduled_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STOPPED", "RUNNING", ] + if stateless_group_scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `stateless_group_scheduled_state` ({0}), must be one of {1}" + .format(stateless_group_scheduled_state, allowed_values) + ) self._stateless_group_scheduled_state = stateless_group_scheduled_state diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 362e293a..7aaf6981 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupEntity(object): """ @@ -590,12 +592,13 @@ def process_group_update_strategy(self, process_group_update_strategy): :param process_group_update_strategy: The process_group_update_strategy of this ProcessGroupEntity. :type: str """ - allowed_values = ["CURRENT_GROUP", "CURRENT_GROUP_WITH_CHILDREN", ] - if process_group_update_strategy not in allowed_values: - raise ValueError( - "Invalid value for `process_group_update_strategy` ({0}), must be one of {1}" - .format(process_group_update_strategy, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CURRENT_GROUP", "CURRENT_GROUP_WITH_CHILDREN", ] + if process_group_update_strategy not in allowed_values: + raise ValueError( + "Invalid value for `process_group_update_strategy` ({0}), must be one of {1}" + .format(process_group_update_strategy, allowed_values) + ) self._process_group_update_strategy = process_group_update_strategy @@ -866,12 +869,13 @@ def versioned_flow_state(self, versioned_flow_state): :param versioned_flow_state: The versioned_flow_state of this ProcessGroupEntity. :type: str """ - allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] - if versioned_flow_state not in allowed_values: - raise ValueError( - "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" - .format(versioned_flow_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] + if versioned_flow_state not in allowed_values: + raise ValueError( + "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" + .format(versioned_flow_state, allowed_values) + ) self._versioned_flow_state = versioned_flow_state diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index 0e40874d..ea33ee23 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupFlowDTO(object): """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index 18bb57d9..c561d34d 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupFlowEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_import_entity.py b/nipyapi/nifi/models/process_group_import_entity.py index 7f2f79de..0ae12849 100644 --- a/nipyapi/nifi/models/process_group_import_entity.py +++ b/nipyapi/nifi/models/process_group_import_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupImportEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py index 23c359f4..32194584 100644 --- a/nipyapi/nifi/models/process_group_name_dto.py +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupNameDTO(object): """ diff --git a/nipyapi/nifi/models/process_group_replace_request_dto.py b/nipyapi/nifi/models/process_group_replace_request_dto.py index 720b6fd5..90d67524 100644 --- a/nipyapi/nifi/models/process_group_replace_request_dto.py +++ b/nipyapi/nifi/models/process_group_replace_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupReplaceRequestDTO(object): """ diff --git a/nipyapi/nifi/models/process_group_replace_request_entity.py b/nipyapi/nifi/models/process_group_replace_request_entity.py index a9711591..d34c6aef 100644 --- a/nipyapi/nifi/models/process_group_replace_request_entity.py +++ b/nipyapi/nifi/models/process_group_replace_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupReplaceRequestEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index 0e6b6441..4620b3bb 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupStatusDTO(object): """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index f92108ac..5fb7f2c5 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupStatusEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index abd5c544..4be50464 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupStatusSnapshotDTO(object): """ @@ -1071,12 +1073,13 @@ def versioned_flow_state(self, versioned_flow_state): :param versioned_flow_state: The versioned_flow_state of this ProcessGroupStatusSnapshotDTO. :type: str """ - allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] - if versioned_flow_state not in allowed_values: - raise ValueError( - "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" - .format(versioned_flow_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] + if versioned_flow_state not in allowed_values: + raise ValueError( + "Invalid value for `versioned_flow_state` ({0}), must be one of {1}" + .format(versioned_flow_state, allowed_values) + ) self._versioned_flow_state = versioned_flow_state diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index a1f0d480..1c28779c 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupStatusSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/process_group_upload_entity.py b/nipyapi/nifi/models/process_group_upload_entity.py index 4907be8c..1a2c43e9 100644 --- a/nipyapi/nifi/models/process_group_upload_entity.py +++ b/nipyapi/nifi/models/process_group_upload_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupUploadEntity(object): """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index 58c0ac7d..c6851394 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessGroupsEntity(object): """ diff --git a/nipyapi/nifi/models/processgroups_upload_body.py b/nipyapi/nifi/models/processgroups_upload_body.py index a2acc304..d92650ae 100644 --- a/nipyapi/nifi/models/processgroups_upload_body.py +++ b/nipyapi/nifi/models/processgroups_upload_body.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessgroupsUploadBody(object): """ diff --git a/nipyapi/nifi/models/processing_performance_status_dto.py b/nipyapi/nifi/models/processing_performance_status_dto.py index 1b860c41..5a099a29 100644 --- a/nipyapi/nifi/models/processing_performance_status_dto.py +++ b/nipyapi/nifi/models/processing_performance_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessingPerformanceStatusDTO(object): """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index 80979ad6..ebce1bc7 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorConfigDTO(object): """ @@ -151,7 +153,7 @@ def __init__(self, annotation_data=None, auto_terminated_relationships=None, bac def annotation_data(self): """ Gets the annotation_data of this ProcessorConfigDTO. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + The annotation data for the processor used to relay configuration between a custom UI and the processor. :return: The annotation_data of this ProcessorConfigDTO. :rtype: str @@ -162,7 +164,7 @@ def annotation_data(self): def annotation_data(self, annotation_data): """ Sets the annotation_data of this ProcessorConfigDTO. - The annotation data for the processor used to relay configuration between a custom UI and the procesosr. + The annotation data for the processor used to relay configuration between a custom UI and the processor. :param annotation_data: The annotation_data of this ProcessorConfigDTO. :type: str @@ -266,7 +268,7 @@ def comments(self, comments): def concurrently_schedulable_task_count(self): """ Gets the concurrently_schedulable_task_count of this ProcessorConfigDTO. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored. :return: The concurrently_schedulable_task_count of this ProcessorConfigDTO. :rtype: int @@ -277,7 +279,7 @@ def concurrently_schedulable_task_count(self): def concurrently_schedulable_task_count(self, concurrently_schedulable_task_count): """ Sets the concurrently_schedulable_task_count of this ProcessorConfigDTO. - The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. + The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored. :param concurrently_schedulable_task_count: The concurrently_schedulable_task_count of this ProcessorConfigDTO. :type: int diff --git a/nipyapi/nifi/models/processor_configuration.py b/nipyapi/nifi/models/processor_configuration.py index 5fb427fe..439fd5f7 100644 --- a/nipyapi/nifi/models/processor_configuration.py +++ b/nipyapi/nifi/models/processor_configuration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorConfiguration(object): """ diff --git a/nipyapi/nifi/models/processor_definition.py b/nipyapi/nifi/models/processor_definition.py index c801f99d..9758c38b 100644 --- a/nipyapi/nifi/models/processor_definition.py +++ b/nipyapi/nifi/models/processor_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorDefinition(object): """ @@ -636,12 +638,13 @@ def input_requirement(self, input_requirement): :param input_requirement: The input_requirement of this ProcessorDefinition. :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index ead711cb..5bf73c00 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorDTO(object): """ @@ -45,6 +47,7 @@ class ProcessorDTO(object): 'restricted': 'bool', 'state': 'str', 'style': 'dict(str, str)', +'supports_backlog_reporting': 'bool', 'supports_batching': 'bool', 'supports_parallel_processing': 'bool', 'supports_sensitive_dynamic_properties': 'bool', @@ -72,6 +75,7 @@ class ProcessorDTO(object): 'restricted': 'restricted', 'state': 'state', 'style': 'style', +'supports_backlog_reporting': 'supportsBacklogReporting', 'supports_batching': 'supportsBatching', 'supports_parallel_processing': 'supportsParallelProcessing', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', @@ -80,7 +84,7 @@ class ProcessorDTO(object): 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId' } - def __init__(self, bundle=None, config=None, deprecated=None, description=None, execution_node_restricted=None, extension_missing=None, id=None, input_requirement=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, physical_state=None, position=None, relationships=None, restricted=None, state=None, style=None, supports_batching=None, supports_parallel_processing=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): + def __init__(self, bundle=None, config=None, deprecated=None, description=None, execution_node_restricted=None, extension_missing=None, id=None, input_requirement=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, physical_state=None, position=None, relationships=None, restricted=None, state=None, style=None, supports_backlog_reporting=None, supports_batching=None, supports_parallel_processing=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None): """ ProcessorDTO - a model defined in Swagger """ @@ -103,6 +107,7 @@ def __init__(self, bundle=None, config=None, deprecated=None, description=None, self._restricted = None self._state = None self._style = None + self._supports_backlog_reporting = None self._supports_batching = None self._supports_parallel_processing = None self._supports_sensitive_dynamic_properties = None @@ -147,6 +152,8 @@ def __init__(self, bundle=None, config=None, deprecated=None, description=None, self.state = state if style is not None: self.style = style + if supports_backlog_reporting is not None: + self.supports_backlog_reporting = supports_backlog_reporting if supports_batching is not None: self.supports_batching = supports_batching if supports_parallel_processing is not None: @@ -454,12 +461,13 @@ def physical_state(self, physical_state): :param physical_state: The physical_state of this ProcessorDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] - if physical_state not in allowed_values: - raise ValueError( - "Invalid value for `physical_state` ({0}), must be one of {1}" - .format(physical_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] + if physical_state not in allowed_values: + raise ValueError( + "Invalid value for `physical_state` ({0}), must be one of {1}" + .format(physical_state, allowed_values) + ) self._physical_state = physical_state @@ -550,12 +558,13 @@ def state(self, state): :param state: The state of this ProcessorDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state @@ -582,6 +591,29 @@ def style(self, style): self._style = style + @property + def supports_backlog_reporting(self): + """ + Gets the supports_backlog_reporting of this ProcessorDTO. + Whether the processor implements BacklogReportingProcessor and can report a backlog. + + :return: The supports_backlog_reporting of this ProcessorDTO. + :rtype: bool + """ + return self._supports_backlog_reporting + + @supports_backlog_reporting.setter + def supports_backlog_reporting(self, supports_backlog_reporting): + """ + Sets the supports_backlog_reporting of this ProcessorDTO. + Whether the processor implements BacklogReportingProcessor and can report a backlog. + + :param supports_backlog_reporting: The supports_backlog_reporting of this ProcessorDTO. + :type: bool + """ + + self._supports_backlog_reporting = supports_backlog_reporting + @property def supports_batching(self): """ @@ -717,12 +749,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ProcessorDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index 6609ffb6..22971ae1 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorEntity(object): """ @@ -272,12 +274,13 @@ def physical_state(self, physical_state): :param physical_state: The physical_state of this ProcessorEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] - if physical_state not in allowed_values: - raise ValueError( - "Invalid value for `physical_state` ({0}), must be one of {1}" - .format(physical_state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE", ] + if physical_state not in allowed_values: + raise ValueError( + "Invalid value for `physical_state` ({0}), must be one of {1}" + .format(physical_state, allowed_values) + ) self._physical_state = physical_state diff --git a/nipyapi/nifi/models/processor_run_status_details_dto.py b/nipyapi/nifi/models/processor_run_status_details_dto.py index d334b34c..b81618f6 100644 --- a/nipyapi/nifi/models/processor_run_status_details_dto.py +++ b/nipyapi/nifi/models/processor_run_status_details_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorRunStatusDetailsDTO(object): """ @@ -151,12 +153,13 @@ def run_status(self, run_status): :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/processor_run_status_details_entity.py b/nipyapi/nifi/models/processor_run_status_details_entity.py index 87477172..027485b5 100644 --- a/nipyapi/nifi/models/processor_run_status_details_entity.py +++ b/nipyapi/nifi/models/processor_run_status_details_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorRunStatusDetailsEntity(object): """ diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index f22b5f6f..7dcb2059 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this ProcessorRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", "RUN_ONCE", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", "RUN_ONCE", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index 17d6d8df..f17eefd9 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorStatusDTO(object): """ @@ -210,12 +212,13 @@ def run_status(self, run_status): :param run_status: The run_status of this ProcessorStatusDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] + 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 diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 149d1941..89bb2faf 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorStatusEntity(object): """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index 2ce18b3c..30ad335f 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorStatusSnapshotDTO(object): """ @@ -225,7 +227,7 @@ def bytes_out(self, bytes_out): def bytes_read(self): """ Gets the bytes_read of this ProcessorStatusSnapshotDTO. - The number of bytes read by this Processor in the last 5 mintues + The number of bytes read by this Processor in the last 5 minutes :return: The bytes_read of this ProcessorStatusSnapshotDTO. :rtype: int @@ -236,7 +238,7 @@ def bytes_read(self): def bytes_read(self, bytes_read): """ Sets the bytes_read of this ProcessorStatusSnapshotDTO. - The number of bytes read by this Processor in the last 5 mintues + The number of bytes read by this Processor in the last 5 minutes :param bytes_read: The bytes_read of this ProcessorStatusSnapshotDTO. :type: int @@ -287,12 +289,13 @@ def execution_node(self, execution_node): :param execution_node: The execution_node of this ProcessorStatusSnapshotDTO. :type: str """ - allowed_values = ["ALL", "PRIMARY", ] - if execution_node not in allowed_values: - raise ValueError( - "Invalid value for `execution_node` ({0}), must be one of {1}" - .format(execution_node, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ALL", "PRIMARY", ] + if execution_node not in allowed_values: + raise ValueError( + "Invalid value for `execution_node` ({0}), must be one of {1}" + .format(execution_node, allowed_values) + ) self._execution_node = execution_node @@ -415,7 +418,7 @@ def input(self, input): def name(self): """ Gets the name of this ProcessorStatusSnapshotDTO. - The name of the prcessor. + The name of the processor. :return: The name of this ProcessorStatusSnapshotDTO. :rtype: str @@ -426,7 +429,7 @@ def name(self): def name(self, name): """ Sets the name of this ProcessorStatusSnapshotDTO. - The name of the prcessor. + The name of the processor. :param name: The name of this ProcessorStatusSnapshotDTO. :type: str @@ -521,12 +524,13 @@ def run_status(self, run_status): :param run_status: The run_status of this ProcessorStatusSnapshotDTO. :type: str """ - allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["Running", "Stopped", "Validating", "Disabled", "Invalid", ] + 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 diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index 472f4767..5bc5c800 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorStatusSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index 88c10aa0..3e5870ac 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorTypesEntity(object): """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index 88ac2846..1df30296 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorsEntity(object): """ diff --git a/nipyapi/nifi/models/processors_run_status_details_entity.py b/nipyapi/nifi/models/processors_run_status_details_entity.py index 72ba61a5..45bb6ab3 100644 --- a/nipyapi/nifi/models/processors_run_status_details_entity.py +++ b/nipyapi/nifi/models/processors_run_status_details_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorsRunStatusDetailsEntity(object): """ diff --git a/nipyapi/nifi/models/property_allowable_value.py b/nipyapi/nifi/models/property_allowable_value.py index 53ab2794..901b2464 100644 --- a/nipyapi/nifi/models/property_allowable_value.py +++ b/nipyapi/nifi/models/property_allowable_value.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyAllowableValue(object): """ diff --git a/nipyapi/nifi/models/property_dependency.py b/nipyapi/nifi/models/property_dependency.py index fac62e63..48a0d1bf 100644 --- a/nipyapi/nifi/models/property_dependency.py +++ b/nipyapi/nifi/models/property_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyDependency(object): """ diff --git a/nipyapi/nifi/models/property_dependency_dto.py b/nipyapi/nifi/models/property_dependency_dto.py index 5dbe9230..d74cd80b 100644 --- a/nipyapi/nifi/models/property_dependency_dto.py +++ b/nipyapi/nifi/models/property_dependency_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyDependencyDTO(object): """ diff --git a/nipyapi/nifi/models/property_descriptor.py b/nipyapi/nifi/models/property_descriptor.py index 0f442c87..cd24d8ab 100644 --- a/nipyapi/nifi/models/property_descriptor.py +++ b/nipyapi/nifi/models/property_descriptor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyDescriptor(object): """ @@ -275,12 +277,13 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this PropertyDescriptor. :type: str """ - allowed_values = ["NONE", "ENVIRONMENT", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["NONE", "ENVIRONMENT", "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 diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index 296b27a0..94624438 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyDescriptorDTO(object): """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index c8a5b38e..262f1747 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyDescriptorEntity(object): """ diff --git a/nipyapi/nifi/models/property_group_configuration_dto.py b/nipyapi/nifi/models/property_group_configuration_dto.py index 81a62407..02c13ff9 100644 --- a/nipyapi/nifi/models/property_group_configuration_dto.py +++ b/nipyapi/nifi/models/property_group_configuration_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyGroupConfigurationDTO(object): """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index 49035f6c..86f3f2c0 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyHistoryDTO(object): """ diff --git a/nipyapi/nifi/models/property_listen_port_definition.py b/nipyapi/nifi/models/property_listen_port_definition.py index d7535279..57fae0e1 100644 --- a/nipyapi/nifi/models/property_listen_port_definition.py +++ b/nipyapi/nifi/models/property_listen_port_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyListenPortDefinition(object): """ @@ -90,12 +92,13 @@ def transport_protocol(self, transport_protocol): :param transport_protocol: The transport_protocol of this PropertyListenPortDefinition. :type: str """ - allowed_values = ["TCP", "UDP", ] - if transport_protocol not in allowed_values: - raise ValueError( - "Invalid value for `transport_protocol` ({0}), must be one of {1}" - .format(transport_protocol, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TCP", "UDP", ] + if transport_protocol not in allowed_values: + raise ValueError( + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) + ) self._transport_protocol = transport_protocol diff --git a/nipyapi/nifi/models/property_resource_definition.py b/nipyapi/nifi/models/property_resource_definition.py index 8cfa1989..6e18c1d3 100644 --- a/nipyapi/nifi/models/property_resource_definition.py +++ b/nipyapi/nifi/models/property_resource_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class PropertyResourceDefinition(object): """ @@ -67,12 +69,13 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this PropertyResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE", ] - if cardinality not in allowed_values: - raise ValueError( - "Invalid value for `cardinality` ({0}), must be one of {1}" - .format(cardinality, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["SINGLE", "MULTIPLE", ] + if cardinality not in allowed_values: + raise ValueError( + "Invalid value for `cardinality` ({0}), must be one of {1}" + .format(cardinality, allowed_values) + ) self._cardinality = cardinality @@ -96,13 +99,14 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this PropertyResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] - if not set(resource_types).issubset(set(allowed_values)): - raise ValueError( - "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set(resource_types)-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if Configuration().client_side_validation: + allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] + if not set(resource_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set(resource_types)-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) self._resource_types = resource_types diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 5a937e9a..d3c0fba6 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index 3b620087..1fb7c5e8 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceEntity(object): """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index 6ac21ef9..3718a6fd 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceEventDTO(object): """ @@ -532,7 +534,7 @@ def event_duration(self, event_duration): def event_id(self): """ Gets the event_id of this ProvenanceEventDTO. - The event id. This is a one up number thats unique per node. + The event id. This is a one up number that's unique per node. :return: The event_id of this ProvenanceEventDTO. :rtype: int @@ -543,7 +545,7 @@ def event_id(self): def event_id(self, event_id): """ Sets the event_id of this ProvenanceEventDTO. - The event id. This is a one up number thats unique per node. + The event id. This is a one up number that's unique per node. :param event_id: The event_id of this ProvenanceEventDTO. :type: int @@ -1176,7 +1178,7 @@ def replay_explanation(self, replay_explanation): def source_connection_identifier(self): """ Gets the source_connection_identifier of this ProvenanceEventDTO. - The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event. + The identifier of the queue/connection from which the flowfile was pulled to generate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event. :return: The source_connection_identifier of this ProvenanceEventDTO. :rtype: str @@ -1187,7 +1189,7 @@ def source_connection_identifier(self): def source_connection_identifier(self, source_connection_identifier): """ Sets the source_connection_identifier of this ProvenanceEventDTO. - The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event. + The identifier of the queue/connection from which the flowfile was pulled to generate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event. :param source_connection_identifier: The source_connection_identifier of this ProvenanceEventDTO. :type: str diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index 9d34c5dc..e1e248b0 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceEventEntity(object): """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 12c13a04..dd38a77b 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceLinkDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index d5ae842e..cf8591bf 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceNodeDTO(object): """ @@ -314,12 +316,13 @@ def type(self, type): :param type: The type of this ProvenanceNodeDTO. :type: str """ - allowed_values = ["FLOWFILE", "EVENT", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["FLOWFILE", "EVENT", ] + 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 diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index c2b7ca98..191df5ff 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceOptionsDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index 28b646ef..3db64f66 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceOptionsEntity(object): """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 4f412f80..835047b8 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceRequestDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index af5484aa..6ace62fb 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceResultsDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_search_value_dto.py b/nipyapi/nifi/models/provenance_search_value_dto.py index a83b7410..b868f444 100644 --- a/nipyapi/nifi/models/provenance_search_value_dto.py +++ b/nipyapi/nifi/models/provenance_search_value_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceSearchValueDTO(object): """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index 12e5b60a..4a7cae6b 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvenanceSearchableFieldDTO(object): """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index 1134c6d3..efcc809f 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class QueueSizeDTO(object): """ diff --git a/nipyapi/nifi/models/rebase_analysis_entity.py b/nipyapi/nifi/models/rebase_analysis_entity.py new file mode 100644 index 00000000..c6aacf63 --- /dev/null +++ b/nipyapi/nifi/models/rebase_analysis_entity.py @@ -0,0 +1,317 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class RebaseAnalysisEntity(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 = { + 'analysis_fingerprint': 'str', +'current_version': 'str', +'failure_reason': 'str', +'local_changes': 'list[RebaseChangeDTO]', +'process_group_id': 'str', +'rebase_allowed': 'bool', +'target_version': 'str', +'upstream_changes': 'list[ComponentDifferenceDTO]' } + + attribute_map = { + 'analysis_fingerprint': 'analysisFingerprint', +'current_version': 'currentVersion', +'failure_reason': 'failureReason', +'local_changes': 'localChanges', +'process_group_id': 'processGroupId', +'rebase_allowed': 'rebaseAllowed', +'target_version': 'targetVersion', +'upstream_changes': 'upstreamChanges' } + + def __init__(self, analysis_fingerprint=None, current_version=None, failure_reason=None, local_changes=None, process_group_id=None, rebase_allowed=None, target_version=None, upstream_changes=None): + """ + RebaseAnalysisEntity - a model defined in Swagger + """ + + self._analysis_fingerprint = None + self._current_version = None + self._failure_reason = None + self._local_changes = None + self._process_group_id = None + self._rebase_allowed = None + self._target_version = None + self._upstream_changes = None + + if analysis_fingerprint is not None: + self.analysis_fingerprint = analysis_fingerprint + if current_version is not None: + self.current_version = current_version + if failure_reason is not None: + self.failure_reason = failure_reason + if local_changes is not None: + self.local_changes = local_changes + if process_group_id is not None: + self.process_group_id = process_group_id + if rebase_allowed is not None: + self.rebase_allowed = rebase_allowed + if target_version is not None: + self.target_version = target_version + if upstream_changes is not None: + self.upstream_changes = upstream_changes + + @property + def analysis_fingerprint(self): + """ + Gets the analysis_fingerprint of this RebaseAnalysisEntity. + A fingerprint representing the state of this analysis, used to verify the analysis is still valid when executing the rebase + + :return: The analysis_fingerprint of this RebaseAnalysisEntity. + :rtype: str + """ + return self._analysis_fingerprint + + @analysis_fingerprint.setter + def analysis_fingerprint(self, analysis_fingerprint): + """ + Sets the analysis_fingerprint of this RebaseAnalysisEntity. + A fingerprint representing the state of this analysis, used to verify the analysis is still valid when executing the rebase + + :param analysis_fingerprint: The analysis_fingerprint of this RebaseAnalysisEntity. + :type: str + """ + + self._analysis_fingerprint = analysis_fingerprint + + @property + def current_version(self): + """ + Gets the current_version of this RebaseAnalysisEntity. + The current version of the flow in the Process Group + + :return: The current_version of this RebaseAnalysisEntity. + :rtype: str + """ + return self._current_version + + @current_version.setter + def current_version(self, current_version): + """ + Sets the current_version of this RebaseAnalysisEntity. + The current version of the flow in the Process Group + + :param current_version: The current_version of this RebaseAnalysisEntity. + :type: str + """ + + self._current_version = current_version + + @property + def failure_reason(self): + """ + Gets the failure_reason of this RebaseAnalysisEntity. + The reason the rebase is not allowed, or null if the rebase is allowed + + :return: The failure_reason of this RebaseAnalysisEntity. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this RebaseAnalysisEntity. + The reason the rebase is not allowed, or null if the rebase is allowed + + :param failure_reason: The failure_reason of this RebaseAnalysisEntity. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def local_changes(self): + """ + Gets the local_changes of this RebaseAnalysisEntity. + The list of local changes that were made to the flow since the last version control operation + + :return: The local_changes of this RebaseAnalysisEntity. + :rtype: list[RebaseChangeDTO] + """ + return self._local_changes + + @local_changes.setter + def local_changes(self, local_changes): + """ + Sets the local_changes of this RebaseAnalysisEntity. + The list of local changes that were made to the flow since the last version control operation + + :param local_changes: The local_changes of this RebaseAnalysisEntity. + :type: list[RebaseChangeDTO] + """ + + self._local_changes = local_changes + + @property + def process_group_id(self): + """ + Gets the process_group_id of this RebaseAnalysisEntity. + The ID of the Process Group being rebased + + :return: The process_group_id of this RebaseAnalysisEntity. + :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 RebaseAnalysisEntity. + The ID of the Process Group being rebased + + :param process_group_id: The process_group_id of this RebaseAnalysisEntity. + :type: str + """ + + self._process_group_id = process_group_id + + @property + def rebase_allowed(self): + """ + Gets the rebase_allowed of this RebaseAnalysisEntity. + Whether the rebase is allowed based on the analysis of local and upstream changes + + :return: The rebase_allowed of this RebaseAnalysisEntity. + :rtype: bool + """ + return self._rebase_allowed + + @rebase_allowed.setter + def rebase_allowed(self, rebase_allowed): + """ + Sets the rebase_allowed of this RebaseAnalysisEntity. + Whether the rebase is allowed based on the analysis of local and upstream changes + + :param rebase_allowed: The rebase_allowed of this RebaseAnalysisEntity. + :type: bool + """ + + self._rebase_allowed = rebase_allowed + + @property + def target_version(self): + """ + Gets the target_version of this RebaseAnalysisEntity. + The target version to rebase to + + :return: The target_version of this RebaseAnalysisEntity. + :rtype: str + """ + return self._target_version + + @target_version.setter + def target_version(self, target_version): + """ + Sets the target_version of this RebaseAnalysisEntity. + The target version to rebase to + + :param target_version: The target_version of this RebaseAnalysisEntity. + :type: str + """ + + self._target_version = target_version + + @property + def upstream_changes(self): + """ + Gets the upstream_changes of this RebaseAnalysisEntity. + The set of upstream changes between the current version and the target version in the flow registry + + :return: The upstream_changes of this RebaseAnalysisEntity. + :rtype: list[ComponentDifferenceDTO] + """ + return self._upstream_changes + + @upstream_changes.setter + def upstream_changes(self, upstream_changes): + """ + Sets the upstream_changes of this RebaseAnalysisEntity. + The set of upstream changes between the current version and the target version in the flow registry + + :param upstream_changes: The upstream_changes of this RebaseAnalysisEntity. + :type: list[ComponentDifferenceDTO] + """ + + self._upstream_changes = upstream_changes + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, RebaseAnalysisEntity): + 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/rebase_change_dto.py b/nipyapi/nifi/models/rebase_change_dto.py new file mode 100644 index 00000000..0793c22f --- /dev/null +++ b/nipyapi/nifi/models/rebase_change_dto.py @@ -0,0 +1,373 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class RebaseChangeDTO(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 = { + 'classification': 'str', +'component_id': 'str', +'component_name': 'str', +'component_type': 'str', +'conflict_code': 'str', +'conflict_detail': 'str', +'difference_type': 'str', +'field_name': 'str', +'local_value': 'str', +'registry_value': 'str' } + + attribute_map = { + 'classification': 'classification', +'component_id': 'componentId', +'component_name': 'componentName', +'component_type': 'componentType', +'conflict_code': 'conflictCode', +'conflict_detail': 'conflictDetail', +'difference_type': 'differenceType', +'field_name': 'fieldName', +'local_value': 'localValue', +'registry_value': 'registryValue' } + + def __init__(self, classification=None, component_id=None, component_name=None, component_type=None, conflict_code=None, conflict_detail=None, difference_type=None, field_name=None, local_value=None, registry_value=None): + """ + RebaseChangeDTO - a model defined in Swagger + """ + + self._classification = None + self._component_id = None + self._component_name = None + self._component_type = None + self._conflict_code = None + self._conflict_detail = None + self._difference_type = None + self._field_name = None + self._local_value = None + self._registry_value = None + + if classification is not None: + self.classification = classification + if component_id is not None: + self.component_id = component_id + if component_name is not None: + self.component_name = component_name + if component_type is not None: + self.component_type = component_type + if conflict_code is not None: + self.conflict_code = conflict_code + if conflict_detail is not None: + self.conflict_detail = conflict_detail + if difference_type is not None: + self.difference_type = difference_type + if field_name is not None: + self.field_name = field_name + if local_value is not None: + self.local_value = local_value + if registry_value is not None: + self.registry_value = registry_value + + @property + def classification(self): + """ + Gets the classification of this RebaseChangeDTO. + The classification of this change: COMPATIBLE, CONFLICTING, or UNSUPPORTED + + :return: The classification of this RebaseChangeDTO. + :rtype: str + """ + return self._classification + + @classification.setter + def classification(self, classification): + """ + Sets the classification of this RebaseChangeDTO. + The classification of this change: COMPATIBLE, CONFLICTING, or UNSUPPORTED + + :param classification: The classification of this RebaseChangeDTO. + :type: str + """ + + self._classification = classification + + @property + def component_id(self): + """ + Gets the component_id of this RebaseChangeDTO. + The ID of the component that was changed + + :return: The component_id of this RebaseChangeDTO. + :rtype: str + """ + return self._component_id + + @component_id.setter + def component_id(self, component_id): + """ + Sets the component_id of this RebaseChangeDTO. + The ID of the component that was changed + + :param component_id: The component_id of this RebaseChangeDTO. + :type: str + """ + + self._component_id = component_id + + @property + def component_name(self): + """ + Gets the component_name of this RebaseChangeDTO. + The name of the component that was changed + + :return: The component_name of this RebaseChangeDTO. + :rtype: str + """ + return self._component_name + + @component_name.setter + def component_name(self, component_name): + """ + Sets the component_name of this RebaseChangeDTO. + The name of the component that was changed + + :param component_name: The component_name of this RebaseChangeDTO. + :type: str + """ + + self._component_name = component_name + + @property + def component_type(self): + """ + Gets the component_type of this RebaseChangeDTO. + The type of the component that was changed + + :return: The component_type of this RebaseChangeDTO. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this RebaseChangeDTO. + The type of the component that was changed + + :param component_type: The component_type of this RebaseChangeDTO. + :type: str + """ + + self._component_type = component_type + + @property + def conflict_code(self): + """ + Gets the conflict_code of this RebaseChangeDTO. + A code identifying the type of conflict, or null if the change is not conflicting + + :return: The conflict_code of this RebaseChangeDTO. + :rtype: str + """ + return self._conflict_code + + @conflict_code.setter + def conflict_code(self, conflict_code): + """ + Sets the conflict_code of this RebaseChangeDTO. + A code identifying the type of conflict, or null if the change is not conflicting + + :param conflict_code: The conflict_code of this RebaseChangeDTO. + :type: str + """ + + self._conflict_code = conflict_code + + @property + def conflict_detail(self): + """ + Gets the conflict_detail of this RebaseChangeDTO. + A detailed description of the conflict, or null if the change is not conflicting + + :return: The conflict_detail of this RebaseChangeDTO. + :rtype: str + """ + return self._conflict_detail + + @conflict_detail.setter + def conflict_detail(self, conflict_detail): + """ + Sets the conflict_detail of this RebaseChangeDTO. + A detailed description of the conflict, or null if the change is not conflicting + + :param conflict_detail: The conflict_detail of this RebaseChangeDTO. + :type: str + """ + + self._conflict_detail = conflict_detail + + @property + def difference_type(self): + """ + Gets the difference_type of this RebaseChangeDTO. + The type of difference detected for this change + + :return: The difference_type of this RebaseChangeDTO. + :rtype: str + """ + return self._difference_type + + @difference_type.setter + def difference_type(self, difference_type): + """ + Sets the difference_type of this RebaseChangeDTO. + The type of difference detected for this change + + :param difference_type: The difference_type of this RebaseChangeDTO. + :type: str + """ + + self._difference_type = difference_type + + @property + def field_name(self): + """ + Gets the field_name of this RebaseChangeDTO. + The name of the field that was changed, or null if not applicable + + :return: The field_name of this RebaseChangeDTO. + :rtype: str + """ + return self._field_name + + @field_name.setter + def field_name(self, field_name): + """ + Sets the field_name of this RebaseChangeDTO. + The name of the field that was changed, or null if not applicable + + :param field_name: The field_name of this RebaseChangeDTO. + :type: str + """ + + self._field_name = field_name + + @property + def local_value(self): + """ + Gets the local_value of this RebaseChangeDTO. + The local value of the field, or null if not applicable + + :return: The local_value of this RebaseChangeDTO. + :rtype: str + """ + return self._local_value + + @local_value.setter + def local_value(self, local_value): + """ + Sets the local_value of this RebaseChangeDTO. + The local value of the field, or null if not applicable + + :param local_value: The local_value of this RebaseChangeDTO. + :type: str + """ + + self._local_value = local_value + + @property + def registry_value(self): + """ + Gets the registry_value of this RebaseChangeDTO. + The registry value of the field, or null if not applicable + + :return: The registry_value of this RebaseChangeDTO. + :rtype: str + """ + return self._registry_value + + @registry_value.setter + def registry_value(self, registry_value): + """ + Sets the registry_value of this RebaseChangeDTO. + The registry value of the field, or null if not applicable + + :param registry_value: The registry_value of this RebaseChangeDTO. + :type: str + """ + + self._registry_value = registry_value + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, RebaseChangeDTO): + 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/rebase_request_entity.py b/nipyapi/nifi/models/rebase_request_entity.py new file mode 100644 index 00000000..18947b53 --- /dev/null +++ b/nipyapi/nifi/models/rebase_request_entity.py @@ -0,0 +1,147 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class RebaseRequestEntity(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 = { + 'analysis_fingerprint': 'str', +'version_control_information_entity': 'VersionControlInformationEntity' } + + attribute_map = { + 'analysis_fingerprint': 'analysisFingerprint', +'version_control_information_entity': 'versionControlInformationEntity' } + + def __init__(self, analysis_fingerprint=None, version_control_information_entity=None): + """ + RebaseRequestEntity - a model defined in Swagger + """ + + self._analysis_fingerprint = None + self._version_control_information_entity = None + + if analysis_fingerprint is not None: + self.analysis_fingerprint = analysis_fingerprint + if version_control_information_entity is not None: + self.version_control_information_entity = version_control_information_entity + + @property + def analysis_fingerprint(self): + """ + Gets the analysis_fingerprint of this RebaseRequestEntity. + The fingerprint of the rebase analysis, used to verify the analysis is still valid when executing the rebase + + :return: The analysis_fingerprint of this RebaseRequestEntity. + :rtype: str + """ + return self._analysis_fingerprint + + @analysis_fingerprint.setter + def analysis_fingerprint(self, analysis_fingerprint): + """ + Sets the analysis_fingerprint of this RebaseRequestEntity. + The fingerprint of the rebase analysis, used to verify the analysis is still valid when executing the rebase + + :param analysis_fingerprint: The analysis_fingerprint of this RebaseRequestEntity. + :type: str + """ + + self._analysis_fingerprint = analysis_fingerprint + + @property + def version_control_information_entity(self): + """ + Gets the version_control_information_entity of this RebaseRequestEntity. + + :return: The version_control_information_entity of this RebaseRequestEntity. + :rtype: VersionControlInformationEntity + """ + return self._version_control_information_entity + + @version_control_information_entity.setter + def version_control_information_entity(self, version_control_information_entity): + """ + Sets the version_control_information_entity of this RebaseRequestEntity. + + :param version_control_information_entity: The version_control_information_entity of this RebaseRequestEntity. + :type: VersionControlInformationEntity + """ + + self._version_control_information_entity = version_control_information_entity + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, RebaseRequestEntity): + 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/registered_flow.py b/nipyapi/nifi/models/registered_flow.py index ae56c9ae..d87d57bf 100644 --- a/nipyapi/nifi/models/registered_flow.py +++ b/nipyapi/nifi/models/registered_flow.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegisteredFlow(object): """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot.py b/nipyapi/nifi/models/registered_flow_snapshot.py index 41a39d67..aa40caa6 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot.py +++ b/nipyapi/nifi/models/registered_flow_snapshot.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegisteredFlowSnapshot(object): """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py index f71db4b2..83c48633 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegisteredFlowSnapshotMetadata(object): """ diff --git a/nipyapi/nifi/models/registered_flow_version_info.py b/nipyapi/nifi/models/registered_flow_version_info.py index 020b8b90..ec665386 100644 --- a/nipyapi/nifi/models/registered_flow_version_info.py +++ b/nipyapi/nifi/models/registered_flow_version_info.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegisteredFlowVersionInfo(object): """ diff --git a/nipyapi/nifi/models/relationship.py b/nipyapi/nifi/models/relationship.py index 6db1ee86..5e51771e 100644 --- a/nipyapi/nifi/models/relationship.py +++ b/nipyapi/nifi/models/relationship.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Relationship(object): """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index 4754ee54..e2b3e463 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RelationshipDTO(object): """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index 2eda5f30..db56bae4 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemotePortRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this RemotePortRunStatusEntity. :type: str """ - allowed_values = ["TRANSMITTING", "STOPPED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TRANSMITTING", "STOPPED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index d692a895..5f514a7d 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupContentsDTO(object): """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index e42885f9..8ba122b6 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupDTO(object): """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index d8bd068d..c4f32c02 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupEntity(object): """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index 2868c7cf..4c5a2191 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupPortDTO(object): """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 03a030f9..ade6ca1c 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupPortEntity(object): """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index b2e71f1b..f6389a14 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupStatusDTO(object): """ @@ -284,12 +286,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this RemoteProcessGroupStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 6e29c044..3b518a11 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupStatusEntity(object): """ 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 44be7ca9..7170f7aa 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupStatusSnapshotDTO(object): """ 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 c8baad6c..45ab1f75 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupStatusSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index 93bae761..84061cd2 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RemoteProcessGroupsEntity(object): """ diff --git a/nipyapi/nifi/models/replay_last_event_request_entity.py b/nipyapi/nifi/models/replay_last_event_request_entity.py index e89aa095..4cff1328 100644 --- a/nipyapi/nifi/models/replay_last_event_request_entity.py +++ b/nipyapi/nifi/models/replay_last_event_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReplayLastEventRequestEntity(object): """ @@ -90,12 +92,13 @@ def nodes(self, nodes): :param nodes: The nodes of this ReplayLastEventRequestEntity. :type: str """ - allowed_values = ["ALL", "PRIMARY", ] - if nodes not in allowed_values: - raise ValueError( - "Invalid value for `nodes` ({0}), must be one of {1}" - .format(nodes, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ALL", "PRIMARY", ] + if nodes not in allowed_values: + raise ValueError( + "Invalid value for `nodes` ({0}), must be one of {1}" + .format(nodes, allowed_values) + ) self._nodes = nodes diff --git a/nipyapi/nifi/models/replay_last_event_response_entity.py b/nipyapi/nifi/models/replay_last_event_response_entity.py index 45cdbd48..7e154884 100644 --- a/nipyapi/nifi/models/replay_last_event_response_entity.py +++ b/nipyapi/nifi/models/replay_last_event_response_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReplayLastEventResponseEntity(object): """ @@ -144,12 +146,13 @@ def nodes(self, nodes): :param nodes: The nodes of this ReplayLastEventResponseEntity. :type: str """ - allowed_values = ["ALL", "PRIMARY", ] - if nodes not in allowed_values: - raise ValueError( - "Invalid value for `nodes` ({0}), must be one of {1}" - .format(nodes, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ALL", "PRIMARY", ] + if nodes not in allowed_values: + raise ValueError( + "Invalid value for `nodes` ({0}), must be one of {1}" + .format(nodes, allowed_values) + ) self._nodes = nodes diff --git a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py index dcc5ee3d..c0841846 100644 --- a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReplayLastEventSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/reporting_task_definition.py b/nipyapi/nifi/models/reporting_task_definition.py index 99212ed2..56176ccd 100644 --- a/nipyapi/nifi/models/reporting_task_definition.py +++ b/nipyapi/nifi/models/reporting_task_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskDefinition(object): """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index f4c1e154..fde12015 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskDTO(object): """ @@ -194,7 +196,7 @@ def active_thread_count(self, active_thread_count): def annotation_data(self): """ Gets the annotation_data of this ReportingTaskDTO. - The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task. + The annotation data for the reporting task. This is how the custom UI relays configuration to the reporting task. :return: The annotation_data of this ReportingTaskDTO. :rtype: str @@ -205,7 +207,7 @@ def annotation_data(self): def annotation_data(self, annotation_data): """ Sets the annotation_data of this ReportingTaskDTO. - The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task. + The annotation data for the reporting task. This is how the custom UI relays configuration to the reporting task. :param annotation_data: The annotation_data of this ReportingTaskDTO. :type: str @@ -643,12 +645,13 @@ def state(self, state): :param state: The state of this ReportingTaskDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state @@ -741,12 +744,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ReportingTaskDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index dac938e9..9979cc8d 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskEntity(object): """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index 39354c95..68beeb27 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskRunStatusEntity(object): """ @@ -116,12 +118,13 @@ def state(self, state): :param state: The state of this ReportingTaskRunStatusEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index b708259f..29ac4346 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskStatusDTO(object): """ @@ -95,12 +97,13 @@ def run_status(self, run_status): :param run_status: The run_status of this ReportingTaskStatusDTO. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "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 @@ -124,12 +127,13 @@ def validation_status(self, validation_status): :param validation_status: The validation_status of this ReportingTaskStatusDTO. :type: str """ - allowed_values = ["VALID", "INVALID", "VALIDATING", ] - if validation_status not in allowed_values: - raise ValueError( - "Invalid value for `validation_status` ({0}), must be one of {1}" - .format(validation_status, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["VALID", "INVALID", "VALIDATING", ] + if validation_status not in allowed_values: + raise ValueError( + "Invalid value for `validation_status` ({0}), must be one of {1}" + .format(validation_status, allowed_values) + ) self._validation_status = validation_status diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 0a67c38d..ca32278f 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTaskTypesEntity(object): """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index 1e1f04ca..11d44348 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ReportingTasksEntity(object): """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index a7a4c156..e6c8f966 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RequiredPermissionDTO(object): """ diff --git a/nipyapi/nifi/models/resource_claim_details_dto.py b/nipyapi/nifi/models/resource_claim_details_dto.py index 8c7ff032..0ca83d29 100644 --- a/nipyapi/nifi/models/resource_claim_details_dto.py +++ b/nipyapi/nifi/models/resource_claim_details_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ResourceClaimDetailsDTO(object): """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 22969a79..dd975026 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ResourceDTO(object): """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index 492bf315..67d04026 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ResourcesEntity(object): """ diff --git a/nipyapi/nifi/models/restriction.py b/nipyapi/nifi/models/restriction.py index e7c8b015..624a1cdd 100644 --- a/nipyapi/nifi/models/restriction.py +++ b/nipyapi/nifi/models/restriction.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Restriction(object): """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index ebf2fc20..65e54866 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RevisionDTO(object): """ diff --git a/nipyapi/nifi/models/run_status_details_request_entity.py b/nipyapi/nifi/models/run_status_details_request_entity.py index e6eb62ca..8e90c32b 100644 --- a/nipyapi/nifi/models/run_status_details_request_entity.py +++ b/nipyapi/nifi/models/run_status_details_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RunStatusDetailsRequestEntity(object): """ diff --git a/nipyapi/nifi/models/runtime_manifest.py b/nipyapi/nifi/models/runtime_manifest.py index 2326298a..42a57e2c 100644 --- a/nipyapi/nifi/models/runtime_manifest.py +++ b/nipyapi/nifi/models/runtime_manifest.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RuntimeManifest(object): """ diff --git a/nipyapi/nifi/models/runtime_manifest_entity.py b/nipyapi/nifi/models/runtime_manifest_entity.py index 96aab792..578010ef 100644 --- a/nipyapi/nifi/models/runtime_manifest_entity.py +++ b/nipyapi/nifi/models/runtime_manifest_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RuntimeManifestEntity(object): """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 9d0e89f3..d9837c47 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ScheduleComponentsEntity(object): """ @@ -146,12 +148,13 @@ def state(self, state): :param state: The state of this ScheduleComponentsEntity. :type: str """ - allowed_values = ["RUNNING", "STOPPED", "ENABLED", "DISABLED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["RUNNING", "STOPPED", "ENABLED", "DISABLED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/scheduling_defaults.py b/nipyapi/nifi/models/scheduling_defaults.py index 70859c27..041c5dc3 100644 --- a/nipyapi/nifi/models/scheduling_defaults.py +++ b/nipyapi/nifi/models/scheduling_defaults.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SchedulingDefaults(object): """ @@ -212,12 +214,13 @@ def default_scheduling_strategy(self, default_scheduling_strategy): :param default_scheduling_strategy: The default_scheduling_strategy of this SchedulingDefaults. :type: str """ - allowed_values = ["TIMER_DRIVEN", "CRON_DRIVEN", ] - if default_scheduling_strategy not in allowed_values: - raise ValueError( - "Invalid value for `default_scheduling_strategy` ({0}), must be one of {1}" - .format(default_scheduling_strategy, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TIMER_DRIVEN", "CRON_DRIVEN", ] + if default_scheduling_strategy not in allowed_values: + raise ValueError( + "Invalid value for `default_scheduling_strategy` ({0}), must be one of {1}" + .format(default_scheduling_strategy, allowed_values) + ) self._default_scheduling_strategy = default_scheduling_strategy diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index d4b8315b..9ca2e6f3 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SearchResultGroupDTO(object): """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index e7a2afa5..3462495d 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SearchResultsDTO(object): """ diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index bf86e16a..502dcb1a 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SearchResultsEntity(object): """ diff --git a/nipyapi/nifi/models/secret_dto.py b/nipyapi/nifi/models/secret_dto.py index f0a22e1d..8abf1faa 100644 --- a/nipyapi/nifi/models/secret_dto.py +++ b/nipyapi/nifi/models/secret_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SecretDTO(object): """ diff --git a/nipyapi/nifi/models/secrets_entity.py b/nipyapi/nifi/models/secrets_entity.py index 4cedd6e5..edacadcd 100644 --- a/nipyapi/nifi/models/secrets_entity.py +++ b/nipyapi/nifi/models/secrets_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SecretsEntity(object): """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 98e515cf..15b2041f 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SnippetDTO(object): """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index e6f20642..706a8a39 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SnippetEntity(object): """ diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 72bee303..a8d92a5c 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StartVersionControlRequestEntity(object): """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 64d3a922..b8ce7002 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StateEntryDTO(object): """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 6e28a167..fda82c47 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StateMapDTO(object): """ diff --git a/nipyapi/nifi/models/stateful.py b/nipyapi/nifi/models/stateful.py index 83c3f90e..2e9185b1 100644 --- a/nipyapi/nifi/models/stateful.py +++ b/nipyapi/nifi/models/stateful.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Stateful(object): """ @@ -90,13 +92,14 @@ def scopes(self, scopes): :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))) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index 202af1ce..bd341ed2 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StatusDescriptorDTO(object): """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index 2e5415f0..05ba11f5 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StatusHistoryDTO(object): """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index 9d989819..b8df2710 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StatusHistoryEntity(object): """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index 76038c04..b618d96d 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StatusSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/step_documentation_entity.py b/nipyapi/nifi/models/step_documentation_entity.py index 93b4c54c..a55c1986 100644 --- a/nipyapi/nifi/models/step_documentation_entity.py +++ b/nipyapi/nifi/models/step_documentation_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StepDocumentationEntity(object): """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index d77633d8..0a18bbe7 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StorageUsageDTO(object): """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index f17d3123..c7ee0b20 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class StreamingOutput(object): """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 21eefe92..34b62b12 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SubmitReplayRequestEntity(object): """ diff --git a/nipyapi/nifi/models/supported_mime_types_dto.py b/nipyapi/nifi/models/supported_mime_types_dto.py index 80abc288..180e8fa1 100644 --- a/nipyapi/nifi/models/supported_mime_types_dto.py +++ b/nipyapi/nifi/models/supported_mime_types_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SupportedMimeTypesDTO(object): """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index e3ce49bd..c921abfa 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SystemDiagnosticsDTO(object): """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index 5a7aaf10..20f48992 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SystemDiagnosticsEntity(object): """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index 2293e7ca..015e96a4 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SystemDiagnosticsSnapshotDTO(object): """ diff --git a/nipyapi/nifi/models/system_resource_consideration.py b/nipyapi/nifi/models/system_resource_consideration.py index 0a669fa0..001a7967 100644 --- a/nipyapi/nifi/models/system_resource_consideration.py +++ b/nipyapi/nifi/models/system_resource_consideration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SystemResourceConsideration(object): """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index a4af11be..fe1d9fda 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class TenantDTO(object): """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index 18a5740c..98910cbd 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class TenantEntity(object): """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index a1ae4b23..df67269c 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class TenantsEntity(object): """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index 97d150e7..578e80b4 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class TransactionResultEntity(object): """ 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 3203e16c..d7f9b1a0 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UpdateControllerServiceReferenceRequestEntity(object): """ @@ -151,12 +153,13 @@ def state(self, state): :param state: The state of this UpdateControllerServiceReferenceRequestEntity. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", "STOPPED", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", "STOPPED", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/use_case.py b/nipyapi/nifi/models/use_case.py index e89f069c..63b36d56 100644 --- a/nipyapi/nifi/models/use_case.py +++ b/nipyapi/nifi/models/use_case.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UseCase(object): """ @@ -128,12 +130,13 @@ def input_requirement(self, input_requirement): :param input_requirement: The input_requirement of this UseCase. :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index 1636a1dd..9f9ef39b 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserDTO(object): """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index 4e7f1063..77643f0c 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserEntity(object): """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index a41d410e..23bb9d15 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserGroupDTO(object): """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index cf3f4cfa..6273cfd0 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserGroupEntity(object): """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index b1bbfcef..f4b39cc1 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserGroupsEntity(object): """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index b5e08856..db8b0edd 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UsersEntity(object): """ diff --git a/nipyapi/nifi/models/verify_config_request_dto.py b/nipyapi/nifi/models/verify_config_request_dto.py index 7907bba3..5263668d 100644 --- a/nipyapi/nifi/models/verify_config_request_dto.py +++ b/nipyapi/nifi/models/verify_config_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VerifyConfigRequestDTO(object): """ diff --git a/nipyapi/nifi/models/verify_config_request_entity.py b/nipyapi/nifi/models/verify_config_request_entity.py index 3ab53aeb..bfd6ad2e 100644 --- a/nipyapi/nifi/models/verify_config_request_entity.py +++ b/nipyapi/nifi/models/verify_config_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VerifyConfigRequestEntity(object): """ diff --git a/nipyapi/nifi/models/verify_config_update_step_dto.py b/nipyapi/nifi/models/verify_config_update_step_dto.py index a16706e5..9949908b 100644 --- a/nipyapi/nifi/models/verify_config_update_step_dto.py +++ b/nipyapi/nifi/models/verify_config_update_step_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VerifyConfigUpdateStepDTO(object): """ diff --git a/nipyapi/nifi/models/verify_connector_config_step_request_dto.py b/nipyapi/nifi/models/verify_connector_config_step_request_dto.py index 506f75e3..cc2488f9 100644 --- a/nipyapi/nifi/models/verify_connector_config_step_request_dto.py +++ b/nipyapi/nifi/models/verify_connector_config_step_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VerifyConnectorConfigStepRequestDTO(object): """ diff --git a/nipyapi/nifi/models/verify_connector_config_step_request_entity.py b/nipyapi/nifi/models/verify_connector_config_step_request_entity.py index 02c87e80..713906bf 100644 --- a/nipyapi/nifi/models/verify_connector_config_step_request_entity.py +++ b/nipyapi/nifi/models/verify_connector_config_step_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VerifyConnectorConfigStepRequestEntity(object): """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 6a4c953d..4ba40496 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionControlComponentMappingEntity(object): """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index b393b05e..02aa6ecc 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionControlInformationDTO(object): """ @@ -329,12 +331,13 @@ def state(self, state): :param state: The state of this VersionControlInformationDTO. :type: str """ - allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE", ] + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" + .format(state, allowed_values) + ) self._state = state diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index a17c43a2..60a09ec0 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionControlInformationEntity(object): """ diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index 79a5b879..66dc17c9 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionInfoDTO(object): """ diff --git a/nipyapi/nifi/models/versioned_asset.py b/nipyapi/nifi/models/versioned_asset.py index b507a331..aa70e6a3 100644 --- a/nipyapi/nifi/models/versioned_asset.py +++ b/nipyapi/nifi/models/versioned_asset.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedAsset(object): """ diff --git a/nipyapi/nifi/models/versioned_component_state.py b/nipyapi/nifi/models/versioned_component_state.py index f8ddde1f..88bd48e9 100644 --- a/nipyapi/nifi/models/versioned_component_state.py +++ b/nipyapi/nifi/models/versioned_component_state.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedComponentState(object): """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index fdc1ecf2..1c1a207d 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedConnection(object): """ @@ -247,12 +249,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedConnection. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index f559ead1..a661a4e5 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedControllerService(object): """ @@ -246,12 +248,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedControllerService. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -457,12 +460,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedControllerService. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index c4370cde..9e41b4a7 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowCoordinates(object): """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index 12e06890..a9e696bb 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowDTO(object): """ @@ -97,12 +99,13 @@ def action(self, action): :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index 187a8b15..41d22fa8 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_flow_migration_source_dto.py b/nipyapi/nifi/models/versioned_flow_migration_source_dto.py new file mode 100644 index 00000000..d3b86092 --- /dev/null +++ b/nipyapi/nifi/models/versioned_flow_migration_source_dto.py @@ -0,0 +1,373 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class VersionedFlowMigrationSourceDTO(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', +'flow_id': 'str', +'flow_name': 'str', +'ineligibility_reasons': 'list[str]', +'parent_process_group_id': 'str', +'process_group_id': 'str', +'process_group_name': 'str', +'ready_for_migration': 'bool', +'registry_client_id': 'str', +'version': 'str' } + + attribute_map = { + 'bucket_id': 'bucketId', +'flow_id': 'flowId', +'flow_name': 'flowName', +'ineligibility_reasons': 'ineligibilityReasons', +'parent_process_group_id': 'parentProcessGroupId', +'process_group_id': 'processGroupId', +'process_group_name': 'processGroupName', +'ready_for_migration': 'readyForMigration', +'registry_client_id': 'registryClientId', +'version': 'version' } + + def __init__(self, bucket_id=None, flow_id=None, flow_name=None, ineligibility_reasons=None, parent_process_group_id=None, process_group_id=None, process_group_name=None, ready_for_migration=None, registry_client_id=None, version=None): + """ + VersionedFlowMigrationSourceDTO - a model defined in Swagger + """ + + self._bucket_id = None + self._flow_id = None + self._flow_name = None + self._ineligibility_reasons = None + self._parent_process_group_id = None + self._process_group_id = None + self._process_group_name = None + self._ready_for_migration = None + self._registry_client_id = None + self._version = None + + if bucket_id is not None: + self.bucket_id = bucket_id + if flow_id is not None: + self.flow_id = flow_id + if flow_name is not None: + self.flow_name = flow_name + if ineligibility_reasons is not None: + self.ineligibility_reasons = ineligibility_reasons + if parent_process_group_id is not None: + self.parent_process_group_id = parent_process_group_id + if process_group_id is not None: + self.process_group_id = process_group_id + if process_group_name is not None: + self.process_group_name = process_group_name + if ready_for_migration is not None: + self.ready_for_migration = ready_for_migration + if registry_client_id is not None: + self.registry_client_id = registry_client_id + if version is not None: + self.version = version + + @property + def bucket_id(self): + """ + Gets the bucket_id of this VersionedFlowMigrationSourceDTO. + The Flow Registry bucket identifier for the source Process Group. + + :return: The bucket_id of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._bucket_id + + @bucket_id.setter + def bucket_id(self, bucket_id): + """ + Sets the bucket_id of this VersionedFlowMigrationSourceDTO. + The Flow Registry bucket identifier for the source Process Group. + + :param bucket_id: The bucket_id of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._bucket_id = bucket_id + + @property + def flow_id(self): + """ + Gets the flow_id of this VersionedFlowMigrationSourceDTO. + The Flow Registry flow identifier for the source Process Group. + + :return: The flow_id of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._flow_id + + @flow_id.setter + def flow_id(self, flow_id): + """ + Sets the flow_id of this VersionedFlowMigrationSourceDTO. + The Flow Registry flow identifier for the source Process Group. + + :param flow_id: The flow_id of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._flow_id = flow_id + + @property + def flow_name(self): + """ + Gets the flow_name of this VersionedFlowMigrationSourceDTO. + The name of the versioned flow backing the source Process Group, as recorded in the Flow Registry. May be null when the registry has not yet supplied a name (for example, while the source's version control state is SYNC_FAILURE). + + :return: The flow_name of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._flow_name + + @flow_name.setter + def flow_name(self, flow_name): + """ + Sets the flow_name of this VersionedFlowMigrationSourceDTO. + The name of the versioned flow backing the source Process Group, as recorded in the Flow Registry. May be null when the registry has not yet supplied a name (for example, while the source's version control state is SYNC_FAILURE). + + :param flow_name: The flow_name of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._flow_name = flow_name + + @property + def ineligibility_reasons(self): + """ + Gets the ineligibility_reasons of this VersionedFlowMigrationSourceDTO. + User-facing descriptions of all conditions that currently prevent the source Process Group from being migrated. Empty when readyForMigration is true. Each entry describes a single remediable condition (running processors, queued FlowFiles, etc.); every applicable condition is included so the user can address them together. + + :return: The ineligibility_reasons of this VersionedFlowMigrationSourceDTO. + :rtype: list[str] + """ + return self._ineligibility_reasons + + @ineligibility_reasons.setter + def ineligibility_reasons(self, ineligibility_reasons): + """ + Sets the ineligibility_reasons of this VersionedFlowMigrationSourceDTO. + User-facing descriptions of all conditions that currently prevent the source Process Group from being migrated. Empty when readyForMigration is true. Each entry describes a single remediable condition (running processors, queued FlowFiles, etc.); every applicable condition is included so the user can address them together. + + :param ineligibility_reasons: The ineligibility_reasons of this VersionedFlowMigrationSourceDTO. + :type: list[str] + """ + + self._ineligibility_reasons = ineligibility_reasons + + @property + def parent_process_group_id(self): + """ + Gets the parent_process_group_id of this VersionedFlowMigrationSourceDTO. + The identifier of the parent Process Group of the source Process Group. + + :return: The parent_process_group_id of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._parent_process_group_id + + @parent_process_group_id.setter + def parent_process_group_id(self, parent_process_group_id): + """ + Sets the parent_process_group_id of this VersionedFlowMigrationSourceDTO. + The identifier of the parent Process Group of the source Process Group. + + :param parent_process_group_id: The parent_process_group_id of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._parent_process_group_id = parent_process_group_id + + @property + def process_group_id(self): + """ + Gets the process_group_id of this VersionedFlowMigrationSourceDTO. + The identifier of the source Process Group. + + :return: The process_group_id of this VersionedFlowMigrationSourceDTO. + :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 VersionedFlowMigrationSourceDTO. + The identifier of the source Process Group. + + :param process_group_id: The process_group_id of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._process_group_id = process_group_id + + @property + def process_group_name(self): + """ + Gets the process_group_name of this VersionedFlowMigrationSourceDTO. + The name of the source Process Group. + + :return: The process_group_name of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._process_group_name + + @process_group_name.setter + def process_group_name(self, process_group_name): + """ + Sets the process_group_name of this VersionedFlowMigrationSourceDTO. + The name of the source Process Group. + + :param process_group_name: The process_group_name of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._process_group_name = process_group_name + + @property + def ready_for_migration(self): + """ + Gets the ready_for_migration of this VersionedFlowMigrationSourceDTO. + Whether the source Process Group is currently in a state that allows it to be migrated into the target Connector. When false, ineligibilityReasons describes what must change before the migration can proceed. + + :return: The ready_for_migration of this VersionedFlowMigrationSourceDTO. + :rtype: bool + """ + return self._ready_for_migration + + @ready_for_migration.setter + def ready_for_migration(self, ready_for_migration): + """ + Sets the ready_for_migration of this VersionedFlowMigrationSourceDTO. + Whether the source Process Group is currently in a state that allows it to be migrated into the target Connector. When false, ineligibilityReasons describes what must change before the migration can proceed. + + :param ready_for_migration: The ready_for_migration of this VersionedFlowMigrationSourceDTO. + :type: bool + """ + + self._ready_for_migration = ready_for_migration + + @property + def registry_client_id(self): + """ + Gets the registry_client_id of this VersionedFlowMigrationSourceDTO. + The identifier of the Flow Registry client backing the source Process Group. + + :return: The registry_client_id of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._registry_client_id + + @registry_client_id.setter + def registry_client_id(self, registry_client_id): + """ + Sets the registry_client_id of this VersionedFlowMigrationSourceDTO. + The identifier of the Flow Registry client backing the source Process Group. + + :param registry_client_id: The registry_client_id of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._registry_client_id = registry_client_id + + @property + def version(self): + """ + Gets the version of this VersionedFlowMigrationSourceDTO. + The published version of the source Process Group. + + :return: The version of this VersionedFlowMigrationSourceDTO. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this VersionedFlowMigrationSourceDTO. + The published version of the source Process Group. + + :param version: The version of this VersionedFlowMigrationSourceDTO. + :type: str + """ + + self._version = version + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, VersionedFlowMigrationSourceDTO): + 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_flow_migration_sources_entity.py b/nipyapi/nifi/models/versioned_flow_migration_sources_entity.py new file mode 100644 index 00000000..ee069e2d --- /dev/null +++ b/nipyapi/nifi/models/versioned_flow_migration_sources_entity.py @@ -0,0 +1,121 @@ +""" + Apache NiFi REST API + + REST API definition for Apache NiFi web services + + OpenAPI spec version: 2.12.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +import re + +from ..configuration import Configuration + + +class VersionedFlowMigrationSourcesEntity(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 = { + 'migration_sources': 'list[VersionedFlowMigrationSourceDTO]' } + + attribute_map = { + 'migration_sources': 'migrationSources' } + + def __init__(self, migration_sources=None): + """ + VersionedFlowMigrationSourcesEntity - a model defined in Swagger + """ + + self._migration_sources = None + + if migration_sources is not None: + self.migration_sources = migration_sources + + @property + def migration_sources(self): + """ + Gets the migration_sources of this VersionedFlowMigrationSourcesEntity. + The Versioned Process Groups that the Connector can be migrated from. + + :return: The migration_sources of this VersionedFlowMigrationSourcesEntity. + :rtype: list[VersionedFlowMigrationSourceDTO] + """ + return self._migration_sources + + @migration_sources.setter + def migration_sources(self, migration_sources): + """ + Sets the migration_sources of this VersionedFlowMigrationSourcesEntity. + The Versioned Process Groups that the Connector can be migrated from. + + :param migration_sources: The migration_sources of this VersionedFlowMigrationSourcesEntity. + :type: list[VersionedFlowMigrationSourceDTO] + """ + + self._migration_sources = migration_sources + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in self.swagger_types.items(): + 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, VersionedFlowMigrationSourcesEntity): + 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_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 29bf1f9f..f3f539bc 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowSnapshotEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index ec194d5e..a8002325 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowSnapshotMetadataEntity(object): """ 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 18a51219..e22920b2 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowSnapshotMetadataSetEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 286390b7..92ca2a1a 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowUpdateRequestDTO(object): """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index f39ac636..d4c72cf2 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowUpdateRequestEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index 4da3f432..703cefe7 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowsEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index af204e3d..b7a2b4f4 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFunnel(object): """ @@ -113,12 +115,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedFunnel. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index f2542aba..adb11234 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedLabel(object): """ @@ -138,12 +140,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedLabel. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/nifi/models/versioned_listen_port_definition.py b/nipyapi/nifi/models/versioned_listen_port_definition.py index f88f6add..455a33b1 100644 --- a/nipyapi/nifi/models/versioned_listen_port_definition.py +++ b/nipyapi/nifi/models/versioned_listen_port_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedListenPortDefinition(object): """ @@ -90,12 +92,13 @@ def transport_protocol(self, transport_protocol): :param transport_protocol: The transport_protocol of this VersionedListenPortDefinition. :type: str """ - allowed_values = ["TCP", "UDP", ] - if transport_protocol not in allowed_values: - raise ValueError( - "Invalid value for `transport_protocol` ({0}), must be one of {1}" - .format(transport_protocol, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TCP", "UDP", ] + if transport_protocol not in allowed_values: + raise ValueError( + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) + ) self._transport_protocol = transport_protocol diff --git a/nipyapi/nifi/models/versioned_node_state.py b/nipyapi/nifi/models/versioned_node_state.py index 8611e340..79db5823 100644 --- a/nipyapi/nifi/models/versioned_node_state.py +++ b/nipyapi/nifi/models/versioned_node_state.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedNodeState(object): """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py index 7b56043a..f0937ad9 100644 --- a/nipyapi/nifi/models/versioned_parameter.py +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedParameter(object): """ diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py index 243b6bd4..d0bb6bb8 100644 --- a/nipyapi/nifi/models/versioned_parameter_context.py +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedParameterContext(object): """ @@ -143,12 +145,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedParameterContext. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index d596b799..78ba51e9 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedPort(object): """ @@ -161,12 +163,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedPort. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -305,12 +308,13 @@ def port_function(self, port_function): :param port_function: The port_function of this VersionedPort. :type: str """ - allowed_values = ["STANDARD", "FAILURE", ] - if port_function not in allowed_values: - raise ValueError( - "Invalid value for `port_function` ({0}), must be one of {1}" - .format(port_function, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STANDARD", "FAILURE", ] + if port_function not in allowed_values: + raise ValueError( + "Invalid value for `port_function` ({0}), must be one of {1}" + .format(port_function, allowed_values) + ) self._port_function = port_function @@ -355,12 +359,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 @@ -384,12 +389,13 @@ def type(self, type): :param type: The type of this VersionedPort. :type: str """ - allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] + 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 diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index a8664f1d..0dfe2f1f 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedProcessGroup(object): """ @@ -218,12 +220,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedProcessGroup. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -362,12 +365,13 @@ def execution_engine(self, execution_engine): :param execution_engine: The execution_engine of this VersionedProcessGroup. :type: str """ - allowed_values = ["STANDARD", "STATELESS", "INHERITED", ] - if execution_engine not in allowed_values: - raise ValueError( - "Invalid value for `execution_engine` ({0}), must be one of {1}" - .format(execution_engine, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STANDARD", "STATELESS", "INHERITED", ] + if execution_engine not in allowed_values: + raise ValueError( + "Invalid value for `execution_engine` ({0}), must be one of {1}" + .format(execution_engine, allowed_values) + ) self._execution_engine = execution_engine @@ -780,12 +784,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessGroup. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index 54806bfe..a79a4c40 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedProcessor(object): """ @@ -352,12 +354,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedProcessor. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -701,12 +704,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessor. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 25c0d03f..a269095e 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedPropertyDescriptor(object): """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index 61ab79b5..780f84d8 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedRemoteGroupPort(object): """ @@ -164,12 +166,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedRemoteGroupPort. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -352,12 +355,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index cc4e06ab..68be3880 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedRemoteProcessGroup(object): """ @@ -191,12 +193,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedRemoteProcessGroup. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/nifi/models/versioned_reporting_task.py b/nipyapi/nifi/models/versioned_reporting_task.py index 04e81440..d9c0e8d9 100644 --- a/nipyapi/nifi/models/versioned_reporting_task.py +++ b/nipyapi/nifi/models/versioned_reporting_task.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedReportingTask(object): """ @@ -223,12 +225,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedReportingTask. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -411,12 +414,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedReportingTask. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py b/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py index 202737f8..e2494165 100644 --- a/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py +++ b/nipyapi/nifi/models/versioned_reporting_task_import_request_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedReportingTaskImportRequestEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py b/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py index 6c67943d..761332bb 100644 --- a/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py +++ b/nipyapi/nifi/models/versioned_reporting_task_import_response_entity.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedReportingTaskImportResponseEntity(object): """ diff --git a/nipyapi/nifi/models/versioned_reporting_task_snapshot.py b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py index 1817146d..1f4c8808 100644 --- a/nipyapi/nifi/models/versioned_reporting_task_snapshot.py +++ b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedReportingTaskSnapshot(object): """ diff --git a/nipyapi/nifi/models/versioned_resource_definition.py b/nipyapi/nifi/models/versioned_resource_definition.py index 5ef953cb..939cc10d 100644 --- a/nipyapi/nifi/models/versioned_resource_definition.py +++ b/nipyapi/nifi/models/versioned_resource_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedResourceDefinition(object): """ @@ -67,12 +69,13 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this VersionedResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE", ] - if cardinality not in allowed_values: - raise ValueError( - "Invalid value for `cardinality` ({0}), must be one of {1}" - .format(cardinality, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["SINGLE", "MULTIPLE", ] + if cardinality not in allowed_values: + raise ValueError( + "Invalid value for `cardinality` ({0}), must be one of {1}" + .format(cardinality, allowed_values) + ) self._cardinality = cardinality @@ -96,13 +99,14 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this VersionedResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] - if not set(resource_types).issubset(set(allowed_values)): - raise ValueError( - "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set(resource_types)-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if Configuration().client_side_validation: + allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] + if not set(resource_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set(resource_types)-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) self._resource_types = resource_types diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 3541a3ef..9126219d 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi_registry.py b/nipyapi/nifi_registry.py index e3baf4e7..2577f385 100644 --- a/nipyapi/nifi_registry.py +++ b/nipyapi/nifi_registry.py @@ -532,9 +532,7 @@ def save_flow_ver( flow_id=flow_id, registry_id=registry_client.id, ) - if nipyapi.utils.check_version("1.10.0") <= 0: - # no 'action' property in versions < 1.10 - flow_dto.action = "FORCE_COMMIT" if force else "COMMIT" + flow_dto.action = "FORCE_COMMIT" if force else "COMMIT" with nipyapi.utils.rest_exceptions(): nipyapi.utils.validate_parameters_versioning_support() return nipyapi.nifi.VersionsApi().save_to_flow_registry( diff --git a/nipyapi/parameters.py b/nipyapi/parameters.py index 8fe6011c..6fd25948 100644 --- a/nipyapi/parameters.py +++ b/nipyapi/parameters.py @@ -12,7 +12,7 @@ ParameterDTO, ParameterEntity, ) -from nipyapi.utils import enforce_min_ver, exception_handler +from nipyapi.utils import exception_handler log = logging.getLogger(__name__) @@ -20,6 +20,17 @@ _NOT_PROVIDED = object() __all__ = [ + "list_all_parameter_providers", + "get_parameter_provider", + "list_all_parameter_provider_types", + "get_parameter_provider_type", + "update_parameter_provider", + "fetch_parameter_provider", + "apply_parameter_provider", + "fetch_and_apply_parameter_provider", + "set_inherited_parameter_contexts", + "get_process_group_parameter_context", + "connect_parameter_provider_group", "list_all_parameter_contexts", "list_orphaned_contexts", "create_parameter_context", @@ -44,6 +55,333 @@ ] +def list_all_parameter_providers(): + """List all parameter providers. + + Returns: + list[ParameterProviderEntity]: Configured providers. + """ + return nipyapi.nifi.FlowApi().get_parameter_providers().parameter_providers + + +@exception_handler(404, None) +def get_parameter_provider(identifier, identifier_type="name", greedy=True): + """Find parameter providers by name, ID, or provider type. + + Args: + identifier (str): Name, ID, or provider class name to match. + identifier_type (str): One of "name", "id", or "type". + greedy (bool): Use substring matching instead of exact matching. + + Returns: + ParameterProviderEntity or list or None: Single match, multiple matches, + or None when no provider matches. + """ + assert isinstance(identifier, str) + assert identifier_type in ["name", "id", "type"] + if identifier_type == "id": + return nipyapi.nifi.ParameterProvidersApi().get_parameter_provider(identifier) + return nipyapi.utils.filter_obj( + list_all_parameter_providers(), identifier, identifier_type, greedy=greedy + ) + + +def list_all_parameter_provider_types(): + """List available parameter provider types. + + Returns: + list[DocumentedTypeDTO]: Installed provider types. + """ + return nipyapi.nifi.FlowApi().get_parameter_provider_types().parameter_provider_types + + +def get_parameter_provider_type(identifier, identifier_type="name", greedy=True): + """Find installed parameter provider types. + + Args: + identifier (str): Class name, bundle, or tag to match. + identifier_type (str): Registered DocumentedTypeDTO filter field. + greedy (bool): Use substring matching instead of exact matching. + + Returns: + DocumentedTypeDTO or list or None: Matching provider type(s). + """ + with nipyapi.utils.rest_exceptions(): + types = list_all_parameter_provider_types() + if types: + return nipyapi.utils.filter_obj(types, identifier, identifier_type, greedy=greedy) + return types + + +def update_parameter_provider( # pylint: disable=too-many-arguments,too-many-positional-arguments + provider, properties, greedy=True, identifier_type="auto", allow_dynamic=False, refresh=True +): + """Update provider properties, optionally refreshing the provider first. + + Args: + provider (ParameterProviderEntity or str): Provider entity, ID, or name. + properties (dict): Property names and values; None clears a property. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name". + allow_dynamic (bool): Allow keys absent from static property descriptors. + refresh (bool): Refresh the provider before updating. Defaults to True. + + Returns: + ParameterProviderEntity: Updated provider, with sensitive properties masked by NiFi. + + Raises: + ValueError: If lookup is ambiguous or a property name is unknown. + TypeError: If properties is not a dictionary. + """ + if not isinstance(properties, dict): + raise TypeError("properties must be a dictionary") + live = nipyapi.utils.resolve_entity( + provider, + get_parameter_provider, + nipyapi.nifi.ParameterProviderEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + if refresh: + live = get_parameter_provider(live.id, identifier_type="id") + # Reuse the descriptor validation shared by processor and controller configuration. + component = nipyapi.canvas._prepare_component_config( # pylint: disable=protected-access + live.component.descriptors or {}, + live.component.type, + nipyapi.nifi.ParameterProviderDTO, + properties, + allow_dynamic, + ) + component.id = live.id + return nipyapi.nifi.ParameterProvidersApi().update_parameter_provider( + id=live.id, + body=nipyapi.nifi.ParameterProviderEntity( + id=live.id, + revision=live.revision, + component=component, + ), + ) + + +def fetch_parameter_provider(provider, greedy=True, identifier_type="auto", refresh=True): + """Fetch and stage provider parameters without applying them to contexts. + + This is a write operation. The synchronous POST response contains staged groups. + + Args: + provider (ParameterProviderEntity or str): Provider entity, ID, or name. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name". + refresh (bool): Refresh the provider before the operation. Defaults to True. + + Returns: + ParameterProviderEntity: Provider with staged parameter groups. + + Raises: + ValueError: If lookup fails. + ApiException: If fetch fails; the original NiFi response is preserved. + """ + live = nipyapi.utils.resolve_entity( + provider, + get_parameter_provider, + nipyapi.nifi.ParameterProviderEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + if refresh: + live = get_parameter_provider(live.id, identifier_type="id") + try: + return nipyapi.nifi.ParameterProvidersApi().fetch_parameters( + id=live.id, + body=nipyapi.nifi.ParameterProviderParameterFetchEntity( + id=live.id, + revision=live.revision, + ), + ) + except nipyapi.nifi.rest.ApiException as exc: + if exc.status == 500: + log.warning( + "Provider fetch failed (HTTP 500). Check provider configuration and source " + "access; consider narrowing its scope before retrying." + ) + raise + + +def _select_parameter_groups(provider, group_names): + groups = provider.component.parameter_group_configurations or [] + if group_names is None: + return groups + if isinstance(group_names, str): + group_names = [group_names] + if not isinstance(group_names, (list, tuple)) or not all( + isinstance(name, str) for name in group_names + ): + raise TypeError("group_names must be a name or a list of names") + missing = set(group_names) - {group.group_name for group in groups} + if missing: + raise ValueError(f"Unknown parameter groups: {sorted(missing)}") + return [group for group in groups if group.group_name in group_names] + + +# pylint: disable-next=too-many-arguments,too-many-positional-arguments,too-many-locals +def apply_parameter_provider( + provider, + group_names=None, + sensitivity="SENSITIVE", + sensitivities=None, + synchronized=None, + fetch_result=None, + greedy=True, + identifier_type="auto", + refresh=True, +): + """Apply selected staged groups and wait for the completed request. + + Args: + provider (ParameterProviderEntity or str): Provider entity, ID, or name. + group_names (list[str] or str): Groups to apply; None selects all staged groups. + sensitivity (str): Default "SENSITIVE" or "NON_SENSITIVE" for unset choices. + sensitivities (dict): Parameter name to "SENSITIVE" or "NON_SENSITIVE". Each name + applies in every selected group and must match a staged parameter; other + parameters retain their staged choices. + synchronized (bool): Override whether contexts stay synchronized with their provider + group. None (default) keeps the staged value, or True where unset; NiFi skips + unsynchronized groups on apply, and a warning is logged when none remain. + fetch_result (ParameterProviderEntity): Optional staged response from fetch. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name". + refresh (bool): Refresh the provider before the operation. Defaults to True. + + Returns: + ParameterProviderApplyParametersRequestDTO: Completed request including affected + components. Sensitive parameter values remain masked by NiFi. + + Raises: + ValueError: Invalid group, sensitivity, or parameter name, mismatched fetch, + or failed request. + """ + if sensitivity not in {"SENSITIVE", "NON_SENSITIVE"}: + raise ValueError("sensitivity must be SENSITIVE or NON_SENSITIVE") + if sensitivities is not None and not isinstance(sensitivities, dict): + raise TypeError("sensitivities must be a dictionary") + overrides = sensitivities or {} + if any(value not in {"SENSITIVE", "NON_SENSITIVE"} for value in overrides.values()): + raise ValueError("sensitivities must contain SENSITIVE or NON_SENSITIVE values") + if synchronized is not None and not isinstance(synchronized, bool): + raise TypeError("synchronized must be a boolean or None") + live = nipyapi.utils.resolve_entity( + provider, + get_parameter_provider, + nipyapi.nifi.ParameterProviderEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + if refresh: + live = get_parameter_provider(live.id, identifier_type="id") + if fetch_result is not None and ( + not isinstance(fetch_result, nipyapi.nifi.ParameterProviderEntity) + or fetch_result.id != live.id + ): + raise ValueError("fetch_result must belong to the selected provider") + groups = _select_parameter_groups( + fetch_result if fetch_result is not None else live, group_names + ) + unknown = set(overrides).difference(*[group.parameter_sensitivities or {} for group in groups]) + if unknown: + raise ValueError(f"Unknown parameters in sensitivities: {sorted(unknown)}") + configurations = [ + nipyapi.nifi.ParameterGroupConfigurationEntity( + group_name=group.group_name, + parameter_context_name=group.parameter_context_name or group.group_name, + parameter_sensitivities={ + name: overrides.get(name, value or sensitivity) + for name, value in (group.parameter_sensitivities or {}).items() + }, + synchronized=( + synchronized if synchronized is not None else group.synchronized is not False + ), + ) + for group in groups + ] + handle = nipyapi.nifi.ParameterProvidersApi() + submitted = handle.submit_apply_parameters( + provider_id=live.id, + body=nipyapi.nifi.ParameterProviderParameterApplicationEntity( + id=live.id, + revision=live.revision, + parameter_group_configurations=configurations, + ), + ) + request_id = submitted.request.request_id + result = nipyapi.utils.wait_for_request( + lambda: handle.get_parameter_provider_apply_parameters_request(live.id, request_id), + lambda: handle.delete_apply_parameters_request(live.id, request_id), + nipyapi_delay=1, + nipyapi_max_wait=nipyapi.config.long_max_wait, + ) + if not any(configuration.synchronized for configuration in configurations): + log.warning( + "Parameter provider %s apply completed with nothing to apply: " + "no synchronized groups were selected", + live.id, + ) + return result + + +# pylint: disable-next=too-many-arguments,too-many-positional-arguments +def fetch_and_apply_parameter_provider( + provider, + group_names=None, + sensitivity="SENSITIVE", + sensitivities=None, + synchronized=None, + require_parameters=True, + greedy=True, + identifier_type="auto", + refresh=True, +): + """Fetch provider parameters and apply the selected groups. + + Args: + provider (ParameterProviderEntity or str): Provider entity, ID, or name. + group_names (list[str] or str): Groups to apply; None selects all groups. + sensitivity (str): Default sensitivity for previously unset choices. + sensitivities (dict): Parameter name overrides; see apply_parameter_provider. + synchronized (bool): Synchronized override; see apply_parameter_provider. + require_parameters (bool): Reject missing or empty selected groups. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name". + refresh (bool): Refresh the provider before the operation. Defaults to True. + + Returns: + ParameterProviderApplyParametersRequestDTO: Completed apply request. + + Raises: + ValueError: Missing/empty selected groups, or the errors raised by + apply_parameter_provider. + """ + fetched = fetch_parameter_provider( + provider, greedy=greedy, identifier_type=identifier_type, refresh=refresh + ) + groups = _select_parameter_groups(fetched, group_names) + if require_parameters and ( + not groups or any(not group.parameter_sensitivities for group in groups) + ): + raise ValueError("Selected groups contain no parameters or include an empty group") + return apply_parameter_provider( + fetched, + group_names=group_names, + sensitivity=sensitivity, + sensitivities=sensitivities, + synchronized=synchronized, + fetch_result=fetched, + refresh=refresh, + ) + + def list_all_parameter_contexts(): """ Lists all Parameter Contexts available on the Canvas @@ -51,7 +389,6 @@ def list_all_parameter_contexts(): Returns: list(ParameterContextEntity) """ - enforce_min_ver("1.10.0") handle = nipyapi.nifi.FlowApi() return handle.get_parameter_contexts().parameter_contexts @@ -66,7 +403,6 @@ def list_orphaned_contexts(): Returns: list(ParameterContextEntity): Contexts with no bound process groups """ - enforce_min_ver("1.10.0") all_contexts = list_all_parameter_contexts() return [ctx for ctx in all_contexts if not ctx.component.bound_process_groups] @@ -86,7 +422,6 @@ def get_parameter_context(identifier, identifier_type="name", greedy=True): list(Objects) for multiple matches """ - enforce_min_ver("1.10.0") assert isinstance(identifier, str) assert identifier_type in ["name", "id"] if identifier_type == "id": @@ -114,7 +449,6 @@ def create_parameter_context(name, description=None, parameters=None, inherited_ :class:`~nipyapi.nifi.models.ParameterContextEntity`: The New Parameter Context """ - enforce_min_ver("1.10.0") assert isinstance(name, str) assert description is None or isinstance(description, str) handle = nipyapi.nifi.ParameterContextsApi() @@ -137,24 +471,19 @@ def create_parameter_context(name, description=None, parameters=None, inherited_ def update_parameter_context(context): """ - Update an already existing Parameter Context + Update an already existing Parameter Context. + + Wait for completion and delete the completed request. Request-level failures + raise ValueError. Timeout or polling interruption does not cancel the update; + see utils.wait_for_request for cleanup and error precedence. Args: context (ParameterContextEntity): Parameter Context updated to be applied - refresh (bool): Whether to refresh the object before Updating Returns: :class:`~nipyapi.nifi.models.ParameterContextEntity`: The updated Parameter Context """ - enforce_min_ver("1.10.0") - - def _update_complete(context_id, request_id): - return ( - nipyapi.nifi.ParameterContextsApi() - .get_parameter_context_update(context_id, request_id) - .request.complete - ) if not isinstance(context, ParameterContextEntity): raise ValueError( @@ -173,19 +502,291 @@ def _update_complete(context_id, request_id): # controller services, applying changes, re-enabling services, and restarting # processors. This can take significant time especially with many parameters # or slow-to-connect services. - nipyapi.utils.wait_to_complete( - _update_complete, - target.id, - update_request.request.request_id, + request_id = update_request.request.request_id + nipyapi.utils.wait_for_request( + lambda: handle.get_parameter_context_update(target.id, request_id), + lambda: handle.delete_update_request(context_id=target.id, request_id=request_id), nipyapi_delay=1, nipyapi_max_wait=nipyapi.config.long_max_wait, ) - _ = handle.delete_update_request( - context_id=target.id, request_id=update_request.request.request_id - ) return get_parameter_context(context.id, identifier_type="id") +def _submit_parameter_context_update(context, component): + handle = nipyapi.nifi.ParameterContextsApi() + live = handle.get_parameter_context(context.id) + submitted = handle.submit_parameter_context_update( + context_id=live.id, + body=ParameterContextEntity(id=live.id, revision=live.revision, component=component), + ) + request_id = submitted.request.request_id + return nipyapi.utils.wait_for_request( + lambda: handle.get_parameter_context_update(live.id, request_id), + lambda: handle.delete_update_request(live.id, request_id), + nipyapi_delay=1, + nipyapi_max_wait=nipyapi.config.long_max_wait, + ) + + +def _inherited_context_references(context, inherited, mode, greedy, identifier_type): + if mode not in ("prepend", "replace"): + raise ValueError("mode must be prepend or replace") + if not isinstance(inherited, (list, tuple)): + raise TypeError("inherited must be a list of contexts, IDs, or names") + resolved = [ + nipyapi.utils.resolve_entity( + item, + get_parameter_context, + ParameterContextEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + for item in inherited + ] + if mode == "prepend": + resolved += context.component.inherited_parameter_contexts or [] + references = [] + seen = set() + for item in resolved: + if item.id == context.id: + raise ValueError("A parameter context cannot inherit itself") + if item.id not in seen: + seen.add(item.id) + references.append( + ParameterContextEntity( + id=item.id, + component=ParameterContextDTO( + id=item.id, name=item.component.name if item.component else None + ), + ) + ) + return references + + +def set_inherited_parameter_contexts( + context, inherited, mode="prepend", greedy=True, identifier_type="auto" +): + """Prepend or replace inherited contexts without changing local parameters. + + The target is always re-read, so the update is built from its current + inheritance rather than from a supplied entity. + + Args: + context (ParameterContextEntity or str): Target context, ID, or name. + inherited (list): Context entities, IDs, or names in precedence order. + mode (str): "prepend" puts the listed contexts first, in the given order, including + any already inherited, and keeps the others after them; "replace" removes + the others. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name" for string identifiers. + + Returns: + ParameterContextUpdateRequestDTO: Completed update and affected components. + + Raises: + ValueError: Invalid mode, missing/ambiguous context, or failed update. + ApiException: NiFi rejects the update, including inheritance conflicts (409). + """ + live = nipyapi.utils.resolve_entity( + context, + get_parameter_context, + ParameterContextEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + live = get_parameter_context(live.id, identifier_type="id") + references = _inherited_context_references(live, inherited, mode, greedy, identifier_type) + return _submit_parameter_context_update( + live, + ParameterContextDTO( + id=live.id, + name=live.component.name, + parameters=[], + inherited_parameter_contexts=references, + ), + ) + + +def get_process_group_parameter_context(process_group, greedy=True, identifier_type="auto"): + """Get the context currently bound to a process group. + + The process group is always re-read, so a supplied entity's binding is not trusted. + + Args: + process_group (ProcessGroupEntity or str): Process group entity, ID, or name. + greedy (bool): Allow partial name matching. + identifier_type (str): "auto", "id", or "name". + + Returns: + ParameterContextEntity or None: Bound context, or None for an unbound group. + + Raises: + ValueError: The process group cannot be uniquely resolved. + """ + group = nipyapi.utils.resolve_entity( + process_group, + nipyapi.canvas.get_process_group, + nipyapi.nifi.ProcessGroupEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + group = nipyapi.canvas.get_process_group(group.id, "id") + binding = group.component.parameter_context + return get_parameter_context(binding.id, "id") if binding and binding.id else None + + +def _resolve_context_target(target, greedy, identifier_type): + if isinstance(target, str): + # Query both namespaces rather than silently preferring a colliding name. + candidates = [] + for getter, entity_type in ( + (get_parameter_context, ParameterContextEntity), + (nipyapi.canvas.get_process_group, nipyapi.nifi.ProcessGroupEntity), + ): + result = nipyapi.utils.resolve_entity( + target, + getter, + entity_type, + strict=False, + greedy=greedy, + identifier_type=identifier_type, + ) + if result is not None: + candidates.extend(result if isinstance(result, list) else [result]) + if len(candidates) != 1: + raise ValueError("Target must identify exactly one context or process group") + target = candidates[0] + if isinstance(target, nipyapi.nifi.ProcessGroupEntity): + target = get_process_group_parameter_context(target) + if target is None: + raise ValueError("Process group has no bound parameter context") + return nipyapi.utils.resolve_entity( + target, + get_parameter_context, + ParameterContextEntity, + strict=True, + greedy=greedy, + identifier_type=identifier_type, + ) + + +def _connect_inherited_references(live, source, mappings): + """Prepend a new source; keep an inherited one in place unless it is shadowed.""" + current = live.component.inherited_parameter_contexts or [] + position = next((i for i, item in enumerate(current) if item.id == source.id), None) + if position is None: + return _inherited_context_references(live, [source], "prepend", False, "id") + # The first inherited context defining a name wins, and aliases resolve against it. + names = set(mappings.values()) + for item in current[:position]: + higher = get_parameter_context(item.id, identifier_type="id") + if higher is None or higher.component is None: + raise ValueError( + f"Cannot read higher-precedence inherited context {item.id} to check shadowing" + ) + shadowed = sorted( + names & {entry.parameter.name for entry in higher.component.parameters or []} + ) + if shadowed: + raise ValueError( + f"Inherited context '{higher.component.name}' takes precedence and shadows " + f"{shadowed}; reorder with set_inherited_parameter_contexts(mode='replace')" + ) + return _inherited_context_references(live, [], "prepend", False, "id") + + +def connect_parameter_provider_group( + target, group_name, mappings, identifier_type="auto", greedy=True +): + """Inherit a provider-created context and set local sensitive parameter aliases. + + The target, and any process-group binding, is always re-read before the update. + A context not yet inherited is placed first, because the first inherited context + defining a name wins and aliases resolve against it. An already inherited context + keeps its position unless a higher one defines a mapped source name; then this + raises, so the order can be set with set_inherited_parameter_contexts. + + Args: + target (ParameterContextEntity or ProcessGroupEntity or str): Target context + or process group. A group must have a bound context. Ambiguous names fail. + group_name (str): Exact name of the provider-created parameter context. + mappings (dict): Local parameter name to source parameter name. + identifier_type (str): "auto", "id", or "name" for target lookup. + greedy (bool): Allow partial target name matching. + + Returns: + ParameterContextUpdateRequestDTO: Completed update and affected components. + + Raises: + ValueError: Missing source parameters, ambiguous/unbound target, invalid aliases, + a mapped source name shadowed by a higher-precedence inherited context, + a non-sensitive source parameter (NiFi would leave the sensitive alias + unresolved), or a local non-sensitive parameter that cannot be changed + to sensitive. + """ + if not isinstance(mappings, dict) or not all( + isinstance(name, str) and name and isinstance(source, str) and source + for name, source in mappings.items() + ): + raise TypeError("mappings must map nonempty local names to source parameter names") + live = _resolve_context_target(target, greedy, identifier_type) + live = get_parameter_context(live.id, identifier_type="id") + source = nipyapi.utils.resolve_entity( + group_name, + get_parameter_context, + ParameterContextEntity, + strict=True, + greedy=False, + identifier_type="name", + ) + available = { + item.parameter.name: item.parameter.sensitive for item in source.component.parameters or [] + } + missing = set(mappings.values()) - set(available) + if missing: + raise ValueError( + f"Missing source parameters: {sorted(missing)}; available: {sorted(available)}" + ) + # NiFi leaves a reference unresolved when the sensitivities differ. + missing = sorted({name for name in mappings.values() if not available[name]}) + if missing: + raise ValueError(f"Source parameters are not sensitive: {missing}") + existing = { + item.parameter.name: item.parameter + for item in live.component.parameters or [] + if not item.parameter.inherited + } + for name, source_name in mappings.items(): + if name in existing and not existing[name].sensitive: + raise ValueError( + f"Local parameter '{name}' is non-sensitive; NiFi cannot change its sensitivity" + ) + if name == source_name: + raise ValueError("A local alias cannot reference itself") + references = _connect_inherited_references(live, source, mappings) + aliases = [ + prepare_parameter( + name, + "#{" + source_name + "}", + description=existing[name].description if name in existing else None, + sensitive=True, + ) + for name, source_name in mappings.items() + ] + return _submit_parameter_context_update( + live, + ParameterContextDTO( + id=live.id, + name=live.component.name, + parameters=aliases, + inherited_parameter_contexts=references, + ), + ) + + def rename_parameter_context(context, name, refresh=True, greedy=True, identifier_type="auto"): """ Rename a Parameter Context without resubmitting parameter values. @@ -255,7 +856,6 @@ def delete_parameter_context(context, refresh=True, greedy=True, identifier_type TypeError: If context is not a string or ParameterContextEntity. ValueError: If parameter context not found or multiple matches found. """ - enforce_min_ver("1.10.0") context = nipyapi.utils.resolve_entity( context, get_parameter_context, @@ -298,7 +898,6 @@ def prepare_parameter(name, value=_NOT_PROVIDED, description=None, sensitive=Fal >>> # Explicitly unset/remove a parameter's value >>> param = prepare_parameter("OptionalSetting", value=None) """ - enforce_min_ver("1.10.0") assert all(x is None or isinstance(x, str) for x in [name, description]) if value is _NOT_PROVIDED: @@ -346,7 +945,6 @@ def delete_parameter_from_context(context, parameter_name, greedy=True, identifi TypeError: If context is not a string or ParameterContextEntity. ValueError: If parameter context not found or multiple matches found. """ - enforce_min_ver("1.10.0") context = nipyapi.utils.resolve_entity( context, get_parameter_context, @@ -378,7 +976,6 @@ def upsert_parameter_to_context(context, parameter, greedy=True, identifier_type TypeError: If context is not a string or ParameterContextEntity. ValueError: If parameter context not found or multiple matches found. """ - enforce_min_ver("1.10.0") context = nipyapi.utils.resolve_entity( context, get_parameter_context, @@ -505,7 +1102,6 @@ def get_parameter_context_hierarchy(context_id, include_bindings=False, include_ ... bindings = len(ctx.get('bound_process_groups', [])) ... print(f"{ctx['name']}: {bindings} bindings") """ - enforce_min_ver("1.10.0") ctx = get_parameter_context(context_id, identifier_type="id") if ctx is None: @@ -575,7 +1171,6 @@ def get_parameter_ownership_map(context_id): >>> print(ownership["PostgreSQL Username"]) {'context_id': '...', 'context_name': 'PostgreSQL Source Parameters', ...} """ - enforce_min_ver("1.10.0") hierarchy = get_parameter_context_hierarchy(context_id) ownership_map = {} @@ -628,7 +1223,6 @@ def update_parameter_in_context(context_id, param_name, value, create_if_missing >>> # Create if missing (use with caution - may shadow inherited params) >>> update_parameter_in_context(ctx_id, "NewParam", "value", create_if_missing=True) """ - enforce_min_ver("1.10.0") ctx = get_parameter_context(context_id, identifier_type="id") if ctx is None: @@ -681,7 +1275,6 @@ def list_assets(context_id): >>> for asset in assets: ... print(f"{asset['name']} ({asset['id']})") """ - enforce_min_ver("1.10.0") handle = nipyapi.nifi.ParameterContextsApi() # get_assets1: NiFi 2.10 ConnectorsApi collision suffixed the original @@ -723,7 +1316,6 @@ def upload_asset(context_id, file_path=None, file_bytes=None, filename=None): >>> # Upload from bytes with explicit filename >>> asset = upload_asset(context_id, file_bytes=data, filename="driver.jar") """ - enforce_min_ver("1.10.0") import os # pylint: disable=import-outside-toplevel @@ -770,7 +1362,6 @@ def delete_asset(context_id, asset_id): >>> result = delete_asset(context_id, asset_id) >>> print(f"Deleted: {result['name']}") """ - enforce_min_ver("1.10.0") handle = nipyapi.nifi.ParameterContextsApi() result = handle.delete_asset(context_id=context_id, asset_id=asset_id) @@ -831,7 +1422,6 @@ def prepare_parameter_with_asset( ... ) >>> upsert_parameter_to_context(context, param) """ - enforce_min_ver("1.10.0") # Validate argument combinations has_single = asset_id is not None or asset_name is not None diff --git a/nipyapi/registry/__init__.py b/nipyapi/registry/__init__.py index acf92129..14cf1fa0 100644 --- a/nipyapi/registry/__init__.py +++ b/nipyapi/registry/__init__.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/api_client.py b/nipyapi/registry/api_client.py index 804a917e..e5c866fb 100644 --- a/nipyapi/registry/api_client.py +++ b/nipyapi/registry/api_client.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/about_api.py b/nipyapi/registry/apis/about_api.py index fca11be7..99928553 100644 --- a/nipyapi/registry/apis/about_api.py +++ b/nipyapi/registry/apis/about_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.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 1ea91eae..77bde2ec 100644 --- a/nipyapi/registry/apis/access_api.py +++ b/nipyapi/registry/apis/access_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/bucket_bundles_api.py b/nipyapi/registry/apis/bucket_bundles_api.py index 79546673..de36c8a3 100644 --- a/nipyapi/registry/apis/bucket_bundles_api.py +++ b/nipyapi/registry/apis/bucket_bundles_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/bucket_flows_api.py b/nipyapi/registry/apis/bucket_flows_api.py index 19871712..6f9800ad 100644 --- a/nipyapi/registry/apis/bucket_flows_api.py +++ b/nipyapi/registry/apis/bucket_flows_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/buckets_api.py b/nipyapi/registry/apis/buckets_api.py index ab8d311c..6454e507 100644 --- a/nipyapi/registry/apis/buckets_api.py +++ b/nipyapi/registry/apis/buckets_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/bundles_api.py b/nipyapi/registry/apis/bundles_api.py index ab679294..4c29dfff 100644 --- a/nipyapi/registry/apis/bundles_api.py +++ b/nipyapi/registry/apis/bundles_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -1121,7 +1121,7 @@ def get_bundle_versions1(self, **kwargs): artifact_id (str): 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-'. version (str): - 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.'. + Optional version to filter results. The value may be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. Returns: :class:`~nipyapi.registry.models.list[BundleVersionMetadata]`: The response data. @@ -1150,7 +1150,7 @@ def get_bundle_versions1_with_http_info(self, **kwargs): artifact_id (str): 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-'. version (str): - 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.'. + Optional version to filter results. The value may be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. Returns: tuple: (:class:`~nipyapi.registry.models.list[BundleVersionMetadata]`, status_code, headers) - Response data with HTTP details. diff --git a/nipyapi/registry/apis/config_api.py b/nipyapi/registry/apis/config_api.py index ee54ea76..dba0347d 100644 --- a/nipyapi/registry/apis/config_api.py +++ b/nipyapi/registry/apis/config_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/extension_repository_api.py b/nipyapi/registry/apis/extension_repository_api.py index 7e02ac17..c5df5d18 100644 --- a/nipyapi/registry/apis/extension_repository_api.py +++ b/nipyapi/registry/apis/extension_repository_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/extensions_api.py b/nipyapi/registry/apis/extensions_api.py index 1c823b14..fe5e682e 100644 --- a/nipyapi/registry/apis/extensions_api.py +++ b/nipyapi/registry/apis/extensions_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/flows_api.py b/nipyapi/registry/apis/flows_api.py index ed49b469..876bc497 100644 --- a/nipyapi/registry/apis/flows_api.py +++ b/nipyapi/registry/apis/flows_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/items_api.py b/nipyapi/registry/apis/items_api.py index 8087b577..de747c4d 100644 --- a/nipyapi/registry/apis/items_api.py +++ b/nipyapi/registry/apis/items_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/policies_api.py b/nipyapi/registry/apis/policies_api.py index 1f98b064..24e59e25 100644 --- a/nipyapi/registry/apis/policies_api.py +++ b/nipyapi/registry/apis/policies_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/tenants_api.py b/nipyapi/registry/apis/tenants_api.py index 4dd9b902..a78fe3ca 100644 --- a/nipyapi/registry/apis/tenants_api.py +++ b/nipyapi/registry/apis/tenants_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index 6fa329df..66ba0e5a 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -44,6 +44,10 @@ def __init__(self): self.api_client = None # Temp file folder for downloading files self.temp_folder_path = None + # Validate enum-constrained model fields when they are set. + # Set to False to accept values the generated enums do not list yet + # (e.g. a newer server than the spec the client was generated from). + self.client_side_validation = True # Authentication Settings self.force_basic_auth = False @@ -238,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: 2.10.0\n"\ + "Version of the API: 2.12.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 93a0b120..5649b502 100644 --- a/nipyapi/registry/models/__init__.py +++ b/nipyapi/registry/models/__init__.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/access_policy.py b/nipyapi/registry/models/access_policy.py index 4fd91ec7..7845c5ef 100644 --- a/nipyapi/registry/models/access_policy.py +++ b/nipyapi/registry/models/access_policy.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicy(object): """ @@ -92,12 +94,13 @@ def action(self, action): :param action: The action of this AccessPolicy. :type: str """ - allowed_values = ["read", "write", "delete", ] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["read", "write", "delete", ] + 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 diff --git a/nipyapi/registry/models/access_policy_summary.py b/nipyapi/registry/models/access_policy_summary.py index e68b78e6..2a4299e2 100644 --- a/nipyapi/registry/models/access_policy_summary.py +++ b/nipyapi/registry/models/access_policy_summary.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AccessPolicySummary(object): """ @@ -82,12 +84,13 @@ def action(self, action): :param action: The action of this AccessPolicySummary. :type: str """ - allowed_values = ["read", "write", "delete", ] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["read", "write", "delete", ] + 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 diff --git a/nipyapi/registry/models/allowable_value.py b/nipyapi/registry/models/allowable_value.py index 46d0614e..ea1b05a6 100644 --- a/nipyapi/registry/models/allowable_value.py +++ b/nipyapi/registry/models/allowable_value.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class AllowableValue(object): """ diff --git a/nipyapi/registry/models/attribute.py b/nipyapi/registry/models/attribute.py index 1f22dc27..3e3a36b0 100644 --- a/nipyapi/registry/models/attribute.py +++ b/nipyapi/registry/models/attribute.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Attribute(object): """ diff --git a/nipyapi/registry/models/batch_size.py b/nipyapi/registry/models/batch_size.py index 9af09614..0a67d1f5 100644 --- a/nipyapi/registry/models/batch_size.py +++ b/nipyapi/registry/models/batch_size.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BatchSize(object): """ diff --git a/nipyapi/registry/models/bucket.py b/nipyapi/registry/models/bucket.py index d762ba6d..fe2836cc 100644 --- a/nipyapi/registry/models/bucket.py +++ b/nipyapi/registry/models/bucket.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Bucket(object): """ diff --git a/nipyapi/registry/models/bucket_item.py b/nipyapi/registry/models/bucket_item.py index ed30c176..626e6836 100644 --- a/nipyapi/registry/models/bucket_item.py +++ b/nipyapi/registry/models/bucket_item.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BucketItem(object): """ @@ -312,12 +314,13 @@ def type(self, type): """ 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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/registry/models/build_info.py b/nipyapi/registry/models/build_info.py index 2302ad62..857c8b9c 100644 --- a/nipyapi/registry/models/build_info.py +++ b/nipyapi/registry/models/build_info.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BuildInfo(object): """ diff --git a/nipyapi/registry/models/bundle.py b/nipyapi/registry/models/bundle.py index a82b1e9a..1f43effc 100644 --- a/nipyapi/registry/models/bundle.py +++ b/nipyapi/registry/models/bundle.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Bundle(object): """ diff --git a/nipyapi/registry/models/bundle_info.py b/nipyapi/registry/models/bundle_info.py index f1148787..ad86c02f 100644 --- a/nipyapi/registry/models/bundle_info.py +++ b/nipyapi/registry/models/bundle_info.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundleInfo(object): """ @@ -189,12 +191,13 @@ def bundle_type(self, bundle_type): :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/registry/models/bundle_version.py b/nipyapi/registry/models/bundle_version.py index e7b2faa7..951db044 100644 --- a/nipyapi/registry/models/bundle_version.py +++ b/nipyapi/registry/models/bundle_version.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundleVersion(object): """ diff --git a/nipyapi/registry/models/bundle_version_dependency.py b/nipyapi/registry/models/bundle_version_dependency.py index c8232a7b..82600971 100644 --- a/nipyapi/registry/models/bundle_version_dependency.py +++ b/nipyapi/registry/models/bundle_version_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundleVersionDependency(object): """ diff --git a/nipyapi/registry/models/bundle_version_metadata.py b/nipyapi/registry/models/bundle_version_metadata.py index 0bb12d58..8876474f 100644 --- a/nipyapi/registry/models/bundle_version_metadata.py +++ b/nipyapi/registry/models/bundle_version_metadata.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundleVersionMetadata(object): """ diff --git a/nipyapi/registry/models/bundles_bundle_type_body.py b/nipyapi/registry/models/bundles_bundle_type_body.py index f84f92f9..416e0777 100644 --- a/nipyapi/registry/models/bundles_bundle_type_body.py +++ b/nipyapi/registry/models/bundles_bundle_type_body.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class BundlesBundleTypeBody(object): """ diff --git a/nipyapi/registry/models/client_id_parameter.py b/nipyapi/registry/models/client_id_parameter.py index d0bcc95d..23556ba4 100644 --- a/nipyapi/registry/models/client_id_parameter.py +++ b/nipyapi/registry/models/client_id_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ClientIdParameter(object): """ diff --git a/nipyapi/registry/models/component_difference.py b/nipyapi/registry/models/component_difference.py index 7d34bf7e..e6d0831d 100644 --- a/nipyapi/registry/models/component_difference.py +++ b/nipyapi/registry/models/component_difference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentDifference(object): """ diff --git a/nipyapi/registry/models/component_difference_group.py b/nipyapi/registry/models/component_difference_group.py index 8f5db44b..b59d33e2 100644 --- a/nipyapi/registry/models/component_difference_group.py +++ b/nipyapi/registry/models/component_difference_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ComponentDifferenceGroup(object): """ diff --git a/nipyapi/registry/models/configuration_step.py b/nipyapi/registry/models/configuration_step.py index c6aa34b3..c94fc26f 100644 --- a/nipyapi/registry/models/configuration_step.py +++ b/nipyapi/registry/models/configuration_step.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStep(object): """ diff --git a/nipyapi/registry/models/configuration_step_dependency.py b/nipyapi/registry/models/configuration_step_dependency.py index 11e4207d..37bde0fb 100644 --- a/nipyapi/registry/models/configuration_step_dependency.py +++ b/nipyapi/registry/models/configuration_step_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConfigurationStepDependency(object): """ diff --git a/nipyapi/registry/models/connectable_component.py b/nipyapi/registry/models/connectable_component.py index 01d18e5c..34901a08 100644 --- a/nipyapi/registry/models/connectable_component.py +++ b/nipyapi/registry/models/connectable_component.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectableComponent(object): """ @@ -202,12 +204,13 @@ def type(self, type): :param type: The type of this ConnectableComponent. :type: str """ - allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL", ] + 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 diff --git a/nipyapi/registry/models/connector_property.py b/nipyapi/registry/models/connector_property.py index 49b92dc1..127d779d 100644 --- a/nipyapi/registry/models/connector_property.py +++ b/nipyapi/registry/models/connector_property.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorProperty(object): """ @@ -235,12 +237,13 @@ def property_type(self, property_type): :param property_type: The property_type of this ConnectorProperty. :type: str """ - allowed_values = ["STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST", ] - if property_type not in allowed_values: - raise ValueError( - "Invalid value for `property_type` ({0}), must be one of {1}" - .format(property_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST", ] + if property_type not in allowed_values: + raise ValueError( + "Invalid value for `property_type` ({0}), must be one of {1}" + .format(property_type, allowed_values) + ) self._property_type = property_type diff --git a/nipyapi/registry/models/connector_property_dependency.py b/nipyapi/registry/models/connector_property_dependency.py index faf99202..7e918db1 100644 --- a/nipyapi/registry/models/connector_property_dependency.py +++ b/nipyapi/registry/models/connector_property_dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyDependency(object): """ diff --git a/nipyapi/registry/models/connector_property_group.py b/nipyapi/registry/models/connector_property_group.py index a4360d9a..6471161e 100644 --- a/nipyapi/registry/models/connector_property_group.py +++ b/nipyapi/registry/models/connector_property_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ConnectorPropertyGroup(object): """ diff --git a/nipyapi/registry/models/controller_service_api.py b/nipyapi/registry/models/controller_service_api.py index 6237a023..26c27fb7 100644 --- a/nipyapi/registry/models/controller_service_api.py +++ b/nipyapi/registry/models/controller_service_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceAPI(object): """ diff --git a/nipyapi/registry/models/controller_service_definition.py b/nipyapi/registry/models/controller_service_definition.py index 50bfd7c1..6926aafe 100644 --- a/nipyapi/registry/models/controller_service_definition.py +++ b/nipyapi/registry/models/controller_service_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ControllerServiceDefinition(object): """ diff --git a/nipyapi/registry/models/current_user.py b/nipyapi/registry/models/current_user.py index d3ca54de..b2df1c9a 100644 --- a/nipyapi/registry/models/current_user.py +++ b/nipyapi/registry/models/current_user.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class CurrentUser(object): """ diff --git a/nipyapi/registry/models/default_schedule.py b/nipyapi/registry/models/default_schedule.py index 849980a0..6a7cef63 100644 --- a/nipyapi/registry/models/default_schedule.py +++ b/nipyapi/registry/models/default_schedule.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DefaultSchedule(object): """ diff --git a/nipyapi/registry/models/default_settings.py b/nipyapi/registry/models/default_settings.py index 2e7fa3d1..b412200e 100644 --- a/nipyapi/registry/models/default_settings.py +++ b/nipyapi/registry/models/default_settings.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DefaultSettings(object): """ diff --git a/nipyapi/registry/models/dependency.py b/nipyapi/registry/models/dependency.py index da9635d0..9ff2bc35 100644 --- a/nipyapi/registry/models/dependency.py +++ b/nipyapi/registry/models/dependency.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Dependency(object): """ diff --git a/nipyapi/registry/models/dependent_values.py b/nipyapi/registry/models/dependent_values.py index ace10f2b..ce19c361 100644 --- a/nipyapi/registry/models/dependent_values.py +++ b/nipyapi/registry/models/dependent_values.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DependentValues(object): """ diff --git a/nipyapi/registry/models/deprecation_notice.py b/nipyapi/registry/models/deprecation_notice.py index cc9b4628..f253460d 100644 --- a/nipyapi/registry/models/deprecation_notice.py +++ b/nipyapi/registry/models/deprecation_notice.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DeprecationNotice(object): """ diff --git a/nipyapi/registry/models/dynamic_property.py b/nipyapi/registry/models/dynamic_property.py index f915526b..1211fb64 100644 --- a/nipyapi/registry/models/dynamic_property.py +++ b/nipyapi/registry/models/dynamic_property.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DynamicProperty(object): """ @@ -105,12 +107,13 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this DynamicProperty. :type: str """ - allowed_values = ["NONE", "ENVIRONMENT", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["NONE", "ENVIRONMENT", "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 diff --git a/nipyapi/registry/models/dynamic_relationship.py b/nipyapi/registry/models/dynamic_relationship.py index 94065520..6592376c 100644 --- a/nipyapi/registry/models/dynamic_relationship.py +++ b/nipyapi/registry/models/dynamic_relationship.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class DynamicRelationship(object): """ diff --git a/nipyapi/registry/models/extension.py b/nipyapi/registry/models/extension.py index 122bb8a5..ccbd84c1 100644 --- a/nipyapi/registry/models/extension.py +++ b/nipyapi/registry/models/extension.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Extension(object): """ @@ -353,12 +355,13 @@ def input_requirement(self, input_requirement): :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) - ) + if Configuration().client_side_validation: + 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 @@ -794,12 +797,13 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + 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 diff --git a/nipyapi/registry/models/extension_filter_params.py b/nipyapi/registry/models/extension_filter_params.py index 6ea267aa..d923dc5f 100644 --- a/nipyapi/registry/models/extension_filter_params.py +++ b/nipyapi/registry/models/extension_filter_params.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionFilterParams(object): """ @@ -72,12 +74,13 @@ def bundle_type(self, bundle_type): :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) - ) + if Configuration().client_side_validation: + 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 @@ -101,12 +104,13 @@ def extension_type(self, extension_type): :param extension_type: The extension_type of this ExtensionFilterParams. :type: str """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + 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 diff --git a/nipyapi/registry/models/extension_metadata.py b/nipyapi/registry/models/extension_metadata.py index 936e627e..fd2c9224 100644 --- a/nipyapi/registry/models/extension_metadata.py +++ b/nipyapi/registry/models/extension_metadata.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionMetadata(object): """ @@ -360,12 +362,13 @@ def type(self, type): :param type: The type of this ExtensionMetadata. :type: str """ - allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + 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 diff --git a/nipyapi/registry/models/extension_metadata_container.py b/nipyapi/registry/models/extension_metadata_container.py index 3b02b1d5..0fa8e50e 100644 --- a/nipyapi/registry/models/extension_metadata_container.py +++ b/nipyapi/registry/models/extension_metadata_container.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionMetadataContainer(object): """ diff --git a/nipyapi/registry/models/extension_repo_artifact.py b/nipyapi/registry/models/extension_repo_artifact.py index f6983929..92256125 100644 --- a/nipyapi/registry/models/extension_repo_artifact.py +++ b/nipyapi/registry/models/extension_repo_artifact.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionRepoArtifact(object): """ diff --git a/nipyapi/registry/models/extension_repo_bucket.py b/nipyapi/registry/models/extension_repo_bucket.py index 9d55efec..a904010e 100644 --- a/nipyapi/registry/models/extension_repo_bucket.py +++ b/nipyapi/registry/models/extension_repo_bucket.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionRepoBucket(object): """ diff --git a/nipyapi/registry/models/extension_repo_group.py b/nipyapi/registry/models/extension_repo_group.py index 7e683b92..2db2ac25 100644 --- a/nipyapi/registry/models/extension_repo_group.py +++ b/nipyapi/registry/models/extension_repo_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionRepoGroup(object): """ diff --git a/nipyapi/registry/models/extension_repo_version.py b/nipyapi/registry/models/extension_repo_version.py index 627fdf1a..8d857ec9 100644 --- a/nipyapi/registry/models/extension_repo_version.py +++ b/nipyapi/registry/models/extension_repo_version.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionRepoVersion(object): """ diff --git a/nipyapi/registry/models/extension_repo_version_summary.py b/nipyapi/registry/models/extension_repo_version_summary.py index a7dd0822..1b1cd74d 100644 --- a/nipyapi/registry/models/extension_repo_version_summary.py +++ b/nipyapi/registry/models/extension_repo_version_summary.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExtensionRepoVersionSummary(object): """ diff --git a/nipyapi/registry/models/external_controller_service_reference.py b/nipyapi/registry/models/external_controller_service_reference.py index 245601c9..e786f5bc 100644 --- a/nipyapi/registry/models/external_controller_service_reference.py +++ b/nipyapi/registry/models/external_controller_service_reference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ExternalControllerServiceReference(object): """ diff --git a/nipyapi/registry/models/fields.py b/nipyapi/registry/models/fields.py index ebff58ba..d62a7040 100644 --- a/nipyapi/registry/models/fields.py +++ b/nipyapi/registry/models/fields.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Fields(object): """ diff --git a/nipyapi/registry/models/form_data_content_disposition.py b/nipyapi/registry/models/form_data_content_disposition.py index 9d54fe27..c2a0eff4 100644 --- a/nipyapi/registry/models/form_data_content_disposition.py +++ b/nipyapi/registry/models/form_data_content_disposition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class FormDataContentDisposition(object): """ diff --git a/nipyapi/registry/models/link.py b/nipyapi/registry/models/link.py index 628d6ff5..8a5a509a 100644 --- a/nipyapi/registry/models/link.py +++ b/nipyapi/registry/models/link.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Link(object): """ diff --git a/nipyapi/registry/models/listen_port_definition.py b/nipyapi/registry/models/listen_port_definition.py index 968fada9..f8893193 100644 --- a/nipyapi/registry/models/listen_port_definition.py +++ b/nipyapi/registry/models/listen_port_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ListenPortDefinition(object): """ @@ -90,12 +92,13 @@ def transport_protocol(self, transport_protocol): :param transport_protocol: The transport_protocol of this ListenPortDefinition. :type: str """ - allowed_values = ["TCP", "UDP", ] - if transport_protocol not in allowed_values: - raise ValueError( - "Invalid value for `transport_protocol` ({0}), must be one of {1}" - .format(transport_protocol, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TCP", "UDP", ] + if transport_protocol not in allowed_values: + raise ValueError( + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) + ) self._transport_protocol = transport_protocol diff --git a/nipyapi/registry/models/long_parameter.py b/nipyapi/registry/models/long_parameter.py index b520b7b1..8fe6a332 100644 --- a/nipyapi/registry/models/long_parameter.py +++ b/nipyapi/registry/models/long_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class LongParameter(object): """ diff --git a/nipyapi/registry/models/model_property.py b/nipyapi/registry/models/model_property.py index 84fd2bb7..34f481c3 100644 --- a/nipyapi/registry/models/model_property.py +++ b/nipyapi/registry/models/model_property.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ModelProperty(object): """ @@ -314,12 +316,13 @@ def expression_language_scope(self, expression_language_scope): :param expression_language_scope: The expression_language_scope of this ModelProperty. :type: str """ - allowed_values = ["NONE", "ENVIRONMENT", "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) - ) + if Configuration().client_side_validation: + allowed_values = ["NONE", "ENVIRONMENT", "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 diff --git a/nipyapi/registry/models/multi_processor_use_case.py b/nipyapi/registry/models/multi_processor_use_case.py index dc6325bf..b6d3a2f6 100644 --- a/nipyapi/registry/models/multi_processor_use_case.py +++ b/nipyapi/registry/models/multi_processor_use_case.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class MultiProcessorUseCase(object): """ diff --git a/nipyapi/registry/models/parameter_provider_reference.py b/nipyapi/registry/models/parameter_provider_reference.py index 99331a6f..3b2542a3 100644 --- a/nipyapi/registry/models/parameter_provider_reference.py +++ b/nipyapi/registry/models/parameter_provider_reference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ParameterProviderReference(object): """ diff --git a/nipyapi/registry/models/permissions.py b/nipyapi/registry/models/permissions.py index 848acd78..e53e2f7b 100644 --- a/nipyapi/registry/models/permissions.py +++ b/nipyapi/registry/models/permissions.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Permissions(object): """ diff --git a/nipyapi/registry/models/position.py b/nipyapi/registry/models/position.py index f6384bdc..b0ea2f11 100644 --- a/nipyapi/registry/models/position.py +++ b/nipyapi/registry/models/position.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Position(object): """ diff --git a/nipyapi/registry/models/processor_configuration.py b/nipyapi/registry/models/processor_configuration.py index 848c50e8..7d350458 100644 --- a/nipyapi/registry/models/processor_configuration.py +++ b/nipyapi/registry/models/processor_configuration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProcessorConfiguration(object): """ diff --git a/nipyapi/registry/models/provided_service_api.py b/nipyapi/registry/models/provided_service_api.py index e74921b2..ce7b7742 100644 --- a/nipyapi/registry/models/provided_service_api.py +++ b/nipyapi/registry/models/provided_service_api.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ProvidedServiceAPI(object): """ diff --git a/nipyapi/registry/models/registry_about.py b/nipyapi/registry/models/registry_about.py index 8aff90bf..1ddb1906 100644 --- a/nipyapi/registry/models/registry_about.py +++ b/nipyapi/registry/models/registry_about.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegistryAbout(object): """ diff --git a/nipyapi/registry/models/registry_configuration.py b/nipyapi/registry/models/registry_configuration.py index 193a63c7..60305810 100644 --- a/nipyapi/registry/models/registry_configuration.py +++ b/nipyapi/registry/models/registry_configuration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RegistryConfiguration(object): """ diff --git a/nipyapi/registry/models/relationship.py b/nipyapi/registry/models/relationship.py index b5387bf5..cd4db982 100644 --- a/nipyapi/registry/models/relationship.py +++ b/nipyapi/registry/models/relationship.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Relationship(object): """ diff --git a/nipyapi/registry/models/resource.py b/nipyapi/registry/models/resource.py index 2510dcea..f42a07c4 100644 --- a/nipyapi/registry/models/resource.py +++ b/nipyapi/registry/models/resource.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Resource(object): """ diff --git a/nipyapi/registry/models/resource_definition.py b/nipyapi/registry/models/resource_definition.py index c255656c..34ed8de1 100644 --- a/nipyapi/registry/models/resource_definition.py +++ b/nipyapi/registry/models/resource_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ResourceDefinition(object): """ @@ -67,12 +69,13 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this ResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE", ] - if cardinality not in allowed_values: - raise ValueError( - "Invalid value for `cardinality` ({0}), must be one of {1}" - .format(cardinality, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["SINGLE", "MULTIPLE", ] + if cardinality not in allowed_values: + raise ValueError( + "Invalid value for `cardinality` ({0}), must be one of {1}" + .format(cardinality, allowed_values) + ) self._cardinality = cardinality @@ -96,13 +99,14 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this ResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] - if not set(resource_types).issubset(set(allowed_values)): - raise ValueError( - "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set(resource_types)-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if Configuration().client_side_validation: + allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] + if not set(resource_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set(resource_types)-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) self._resource_types = resource_types diff --git a/nipyapi/registry/models/resource_permissions.py b/nipyapi/registry/models/resource_permissions.py index bc74a363..ec51ba31 100644 --- a/nipyapi/registry/models/resource_permissions.py +++ b/nipyapi/registry/models/resource_permissions.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class ResourcePermissions(object): """ diff --git a/nipyapi/registry/models/restricted.py b/nipyapi/registry/models/restricted.py index 2e22fdbc..7a40d792 100644 --- a/nipyapi/registry/models/restricted.py +++ b/nipyapi/registry/models/restricted.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Restricted(object): """ diff --git a/nipyapi/registry/models/restriction.py b/nipyapi/registry/models/restriction.py index 4812c417..2363b399 100644 --- a/nipyapi/registry/models/restriction.py +++ b/nipyapi/registry/models/restriction.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Restriction(object): """ diff --git a/nipyapi/registry/models/revision_info.py b/nipyapi/registry/models/revision_info.py index 45743e56..b06670b8 100644 --- a/nipyapi/registry/models/revision_info.py +++ b/nipyapi/registry/models/revision_info.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class RevisionInfo(object): """ diff --git a/nipyapi/registry/models/stateful.py b/nipyapi/registry/models/stateful.py index 6d4db2cc..da1c662e 100644 --- a/nipyapi/registry/models/stateful.py +++ b/nipyapi/registry/models/stateful.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Stateful(object): """ @@ -90,13 +92,14 @@ def scopes(self, scopes): :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))) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/registry/models/system_resource_consideration.py b/nipyapi/registry/models/system_resource_consideration.py index 5b6c61b2..cd825235 100644 --- a/nipyapi/registry/models/system_resource_consideration.py +++ b/nipyapi/registry/models/system_resource_consideration.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class SystemResourceConsideration(object): """ diff --git a/nipyapi/registry/models/tag_count.py b/nipyapi/registry/models/tag_count.py index 827828c5..8bf204b5 100644 --- a/nipyapi/registry/models/tag_count.py +++ b/nipyapi/registry/models/tag_count.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class TagCount(object): """ diff --git a/nipyapi/registry/models/tenant.py b/nipyapi/registry/models/tenant.py index 25caf439..8962e8de 100644 --- a/nipyapi/registry/models/tenant.py +++ b/nipyapi/registry/models/tenant.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class Tenant(object): """ diff --git a/nipyapi/registry/models/uri_builder.py b/nipyapi/registry/models/uri_builder.py index 9b61ee6b..73df6b89 100644 --- a/nipyapi/registry/models/uri_builder.py +++ b/nipyapi/registry/models/uri_builder.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UriBuilder(object): """ diff --git a/nipyapi/registry/models/use_case.py b/nipyapi/registry/models/use_case.py index ed3ad2b7..e9762072 100644 --- a/nipyapi/registry/models/use_case.py +++ b/nipyapi/registry/models/use_case.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UseCase(object): """ @@ -122,12 +124,13 @@ def input_requirement(self, input_requirement): :param input_requirement: The input_requirement of this UseCase. :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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/registry/models/user.py b/nipyapi/registry/models/user.py index 38daba1a..d59ed0a3 100644 --- a/nipyapi/registry/models/user.py +++ b/nipyapi/registry/models/user.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class User(object): """ diff --git a/nipyapi/registry/models/user_group.py b/nipyapi/registry/models/user_group.py index 2ed27b08..c9647faa 100644 --- a/nipyapi/registry/models/user_group.py +++ b/nipyapi/registry/models/user_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class UserGroup(object): """ diff --git a/nipyapi/registry/models/versioned_asset.py b/nipyapi/registry/models/versioned_asset.py index d0acd5bc..b707f309 100644 --- a/nipyapi/registry/models/versioned_asset.py +++ b/nipyapi/registry/models/versioned_asset.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedAsset(object): """ diff --git a/nipyapi/registry/models/versioned_component_state.py b/nipyapi/registry/models/versioned_component_state.py index ecb00cca..8f26bf32 100644 --- a/nipyapi/registry/models/versioned_component_state.py +++ b/nipyapi/registry/models/versioned_component_state.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedComponentState(object): """ diff --git a/nipyapi/registry/models/versioned_connection.py b/nipyapi/registry/models/versioned_connection.py index 608ec854..b551e8c5 100644 --- a/nipyapi/registry/models/versioned_connection.py +++ b/nipyapi/registry/models/versioned_connection.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedConnection(object): """ @@ -247,12 +249,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedConnection. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/registry/models/versioned_controller_service.py b/nipyapi/registry/models/versioned_controller_service.py index 74d41773..58b1551e 100644 --- a/nipyapi/registry/models/versioned_controller_service.py +++ b/nipyapi/registry/models/versioned_controller_service.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedControllerService(object): """ @@ -246,12 +248,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedControllerService. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -457,12 +460,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedControllerService. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/registry/models/versioned_flow.py b/nipyapi/registry/models/versioned_flow.py index 174231dd..5a9a601e 100644 --- a/nipyapi/registry/models/versioned_flow.py +++ b/nipyapi/registry/models/versioned_flow.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlow(object): """ @@ -343,12 +345,13 @@ def type(self, type): """ 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) - ) + if Configuration().client_side_validation: + 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 diff --git a/nipyapi/registry/models/versioned_flow_coordinates.py b/nipyapi/registry/models/versioned_flow_coordinates.py index 0910d083..56bee469 100644 --- a/nipyapi/registry/models/versioned_flow_coordinates.py +++ b/nipyapi/registry/models/versioned_flow_coordinates.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowCoordinates(object): """ diff --git a/nipyapi/registry/models/versioned_flow_difference.py b/nipyapi/registry/models/versioned_flow_difference.py index 8901d49c..d8eb3a06 100644 --- a/nipyapi/registry/models/versioned_flow_difference.py +++ b/nipyapi/registry/models/versioned_flow_difference.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowDifference(object): """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot.py b/nipyapi/registry/models/versioned_flow_snapshot.py index c1ed4f8d..ad7aeb81 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot.py +++ b/nipyapi/registry/models/versioned_flow_snapshot.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowSnapshot(object): """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py index 28440ac3..4514a7a4 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFlowSnapshotMetadata(object): """ diff --git a/nipyapi/registry/models/versioned_funnel.py b/nipyapi/registry/models/versioned_funnel.py index ca450ecc..d91e1a2a 100644 --- a/nipyapi/registry/models/versioned_funnel.py +++ b/nipyapi/registry/models/versioned_funnel.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedFunnel(object): """ @@ -113,12 +115,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedFunnel. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/registry/models/versioned_label.py b/nipyapi/registry/models/versioned_label.py index c0dff254..a04422a5 100644 --- a/nipyapi/registry/models/versioned_label.py +++ b/nipyapi/registry/models/versioned_label.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedLabel(object): """ @@ -138,12 +140,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedLabel. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/registry/models/versioned_listen_port_definition.py b/nipyapi/registry/models/versioned_listen_port_definition.py index 74a0ff64..f8b47a48 100644 --- a/nipyapi/registry/models/versioned_listen_port_definition.py +++ b/nipyapi/registry/models/versioned_listen_port_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedListenPortDefinition(object): """ @@ -90,12 +92,13 @@ def transport_protocol(self, transport_protocol): :param transport_protocol: The transport_protocol of this VersionedListenPortDefinition. :type: str """ - allowed_values = ["TCP", "UDP", ] - if transport_protocol not in allowed_values: - raise ValueError( - "Invalid value for `transport_protocol` ({0}), must be one of {1}" - .format(transport_protocol, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["TCP", "UDP", ] + if transport_protocol not in allowed_values: + raise ValueError( + "Invalid value for `transport_protocol` ({0}), must be one of {1}" + .format(transport_protocol, allowed_values) + ) self._transport_protocol = transport_protocol diff --git a/nipyapi/registry/models/versioned_node_state.py b/nipyapi/registry/models/versioned_node_state.py index 75d365e9..e255159a 100644 --- a/nipyapi/registry/models/versioned_node_state.py +++ b/nipyapi/registry/models/versioned_node_state.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedNodeState(object): """ diff --git a/nipyapi/registry/models/versioned_parameter.py b/nipyapi/registry/models/versioned_parameter.py index e7b46bb4..4404bdcb 100644 --- a/nipyapi/registry/models/versioned_parameter.py +++ b/nipyapi/registry/models/versioned_parameter.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedParameter(object): """ diff --git a/nipyapi/registry/models/versioned_parameter_context.py b/nipyapi/registry/models/versioned_parameter_context.py index 727900e7..64815f5e 100644 --- a/nipyapi/registry/models/versioned_parameter_context.py +++ b/nipyapi/registry/models/versioned_parameter_context.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedParameterContext(object): """ @@ -143,12 +145,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedParameterContext. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/registry/models/versioned_port.py b/nipyapi/registry/models/versioned_port.py index 8e6cc10f..ba79d472 100644 --- a/nipyapi/registry/models/versioned_port.py +++ b/nipyapi/registry/models/versioned_port.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedPort(object): """ @@ -161,12 +163,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedPort. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -305,12 +308,13 @@ def port_function(self, port_function): :param port_function: The port_function of this VersionedPort. :type: str """ - allowed_values = ["STANDARD", "FAILURE", ] - if port_function not in allowed_values: - raise ValueError( - "Invalid value for `port_function` ({0}), must be one of {1}" - .format(port_function, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STANDARD", "FAILURE", ] + if port_function not in allowed_values: + raise ValueError( + "Invalid value for `port_function` ({0}), must be one of {1}" + .format(port_function, allowed_values) + ) self._port_function = port_function @@ -355,12 +359,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 @@ -384,12 +389,13 @@ def type(self, type): :param type: The type of this VersionedPort. :type: str """ - allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["INPUT_PORT", "OUTPUT_PORT", ] + 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 diff --git a/nipyapi/registry/models/versioned_process_group.py b/nipyapi/registry/models/versioned_process_group.py index 524e8aec..ed99f0a1 100644 --- a/nipyapi/registry/models/versioned_process_group.py +++ b/nipyapi/registry/models/versioned_process_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedProcessGroup(object): """ @@ -218,12 +220,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedProcessGroup. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -362,12 +365,13 @@ def execution_engine(self, execution_engine): :param execution_engine: The execution_engine of this VersionedProcessGroup. :type: str """ - allowed_values = ["STANDARD", "STATELESS", "INHERITED", ] - if execution_engine not in allowed_values: - raise ValueError( - "Invalid value for `execution_engine` ({0}), must be one of {1}" - .format(execution_engine, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["STANDARD", "STATELESS", "INHERITED", ] + if execution_engine not in allowed_values: + raise ValueError( + "Invalid value for `execution_engine` ({0}), must be one of {1}" + .format(execution_engine, allowed_values) + ) self._execution_engine = execution_engine @@ -780,12 +784,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessGroup. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/registry/models/versioned_processor.py b/nipyapi/registry/models/versioned_processor.py index 0f310fc3..9216efb8 100644 --- a/nipyapi/registry/models/versioned_processor.py +++ b/nipyapi/registry/models/versioned_processor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedProcessor(object): """ @@ -352,12 +354,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedProcessor. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -701,12 +704,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedProcessor. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/registry/models/versioned_property_descriptor.py b/nipyapi/registry/models/versioned_property_descriptor.py index e9eb50af..32e459e3 100644 --- a/nipyapi/registry/models/versioned_property_descriptor.py +++ b/nipyapi/registry/models/versioned_property_descriptor.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedPropertyDescriptor(object): """ diff --git a/nipyapi/registry/models/versioned_remote_group_port.py b/nipyapi/registry/models/versioned_remote_group_port.py index e44f1255..55010a67 100644 --- a/nipyapi/registry/models/versioned_remote_group_port.py +++ b/nipyapi/registry/models/versioned_remote_group_port.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedRemoteGroupPort(object): """ @@ -164,12 +166,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedRemoteGroupPort. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type @@ -352,12 +355,13 @@ def scheduled_state(self, scheduled_state): :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. :type: str """ - allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] - 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) - ) + if Configuration().client_side_validation: + allowed_values = ["ENABLED", "DISABLED", "RUNNING", ] + 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 diff --git a/nipyapi/registry/models/versioned_remote_process_group.py b/nipyapi/registry/models/versioned_remote_process_group.py index e771e587..14fbee61 100644 --- a/nipyapi/registry/models/versioned_remote_process_group.py +++ b/nipyapi/registry/models/versioned_remote_process_group.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedRemoteProcessGroup(object): """ @@ -191,12 +193,13 @@ def component_type(self, component_type): :param component_type: The component_type of this VersionedRemoteProcessGroup. :type: str """ - allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] - if component_type not in allowed_values: - raise ValueError( - "Invalid value for `component_type` ({0}), must be one of {1}" - .format(component_type, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR", ] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) self._component_type = component_type diff --git a/nipyapi/registry/models/versioned_resource_definition.py b/nipyapi/registry/models/versioned_resource_definition.py index a173c0f6..c9ba3463 100644 --- a/nipyapi/registry/models/versioned_resource_definition.py +++ b/nipyapi/registry/models/versioned_resource_definition.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -11,6 +11,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class VersionedResourceDefinition(object): """ @@ -67,12 +69,13 @@ def cardinality(self, cardinality): :param cardinality: The cardinality of this VersionedResourceDefinition. :type: str """ - allowed_values = ["SINGLE", "MULTIPLE", ] - if cardinality not in allowed_values: - raise ValueError( - "Invalid value for `cardinality` ({0}), must be one of {1}" - .format(cardinality, allowed_values) - ) + if Configuration().client_side_validation: + allowed_values = ["SINGLE", "MULTIPLE", ] + if cardinality not in allowed_values: + raise ValueError( + "Invalid value for `cardinality` ({0}), must be one of {1}" + .format(cardinality, allowed_values) + ) self._cardinality = cardinality @@ -96,13 +99,14 @@ def resource_types(self, resource_types): :param resource_types: The resource_types of this VersionedResourceDefinition. :type: list[str] """ - allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] - if not set(resource_types).issubset(set(allowed_values)): - raise ValueError( - "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set(resource_types)-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if Configuration().client_side_validation: + allowed_values = ["FILE", "DIRECTORY", "TEXT", "URL", ] + if not set(resource_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `resource_types` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set(resource_types)-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) self._resource_types = resource_types diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index ba5815bd..19bcb84a 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -3,7 +3,7 @@ REST API definition for Apache NiFi Registry web services - OpenAPI spec version: 2.10.0 + OpenAPI spec version: 2.12.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 708d96a1..7fd67906 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -35,6 +35,7 @@ "resolve_entity", "resolve_schedule_state", "wait_to_complete", + "wait_for_request", "is_endpoint_up", "set_endpoint", "infer_object_label_from_class", @@ -495,6 +496,53 @@ def wait_to_complete(test_function, *args, **kwargs): raise ValueError("Timed Out waiting for {0} to complete".format(test_function.__name__)) +def wait_for_request(get_request, delete_request, nipyapi_delay=None, nipyapi_max_wait=None): + """Wait for a submitted NiFi request and delete it only after completion. + + An unfinished request is not deleted on timeout, polling error or interruption: + deleting it would cancel the operation. Individual verification result outcomes + are returned unchanged; only the request-level failure_reason raises an error. + + Args: + get_request: Bound callback returning an entity with a request DTO whose + complete and failure_reason fields describe the operation. + delete_request: Bound callback deleting the submitted request. + nipyapi_delay (float): Poll interval; defaults to config.short_retry_delay. + nipyapi_max_wait (float): Timeout; defaults to config.short_max_wait. + + Returns: + The completed request DTO, retained before deletion. + + Raises: + ValueError: Timeout or the completed request's failure_reason. + Exception: Polling or deletion errors. A deletion error does not replace + a terminal request failure. + """ + + def completed(): + request = get_request().request + return request if request.complete else False + + result = wait_to_complete( + completed, + nipyapi_delay=( + nipyapi.config.short_retry_delay if nipyapi_delay is None else nipyapi_delay + ), + nipyapi_max_wait=( + nipyapi.config.short_max_wait if nipyapi_max_wait is None else nipyapi_max_wait + ), + ) + try: + delete_request() + except Exception as exc: # pylint: disable=broad-exception-caught + if not result.failure_reason: + raise + log.warning("Could not delete completed failed request: %s", exc) + if result.failure_reason: + raise ValueError(result.failure_reason) + return result + + def is_endpoint_up(endpoint_url): # pylint: disable=too-many-return-statements """ Tests if a URL is available for requests diff --git a/resources/client_gen/api_defs/nifi-2.12.0.json b/resources/client_gen/api_defs/nifi-2.12.0.json new file mode 100644 index 00000000..c6211213 --- /dev/null +++ b/resources/client_gen/api_defs/nifi-2.12.0.json @@ -0,0 +1,35683 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "dev@nifi.apache.org", + "url" : "https://nifi.apache.org" + }, + "description" : "REST API definition for Apache NiFi web services", + "license" : { + "name" : "Apache 2.0", + "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title" : "Apache NiFi REST API", + "version" : "2.12.0" + }, + "security" : [ { + "HTTPBearerJWT" : [ ] + }, { + "CookieSecureAuthorizationBearer" : [ ] + } ], + "paths" : { + "/access/logout" : { + "delete" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "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." + } + }, + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "tags" : [ "Access" ] + } + }, + "/access/logout/complete" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOutComplete", + "responses" : { + "302" : { + "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." + } + }, + "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", + "tags" : [ "Access" ] + } + }, + "/access/token" : { + "post" : { + "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. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.", + "operationId" : "createAccessToken", + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "type" : "object", + "properties" : { + "password" : { + "type" : "string" + }, + "username" : { + "type" : "string" + } + } + } + } + } + }, + "responses" : { + "201" : { + "content" : { + "text/plain" : { + "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" : "The request was valid but NiFi was not in the appropriate state to process it." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + }, + "security" : [ ], + "summary" : "Creates a token for accessing the REST API via username/password", + "tags" : [ "Access" ] + } + }, + "/authentication/configuration" : { + "get" : { + "operationId" : "getAuthenticationConfiguration", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthenticationConfigurationEntity" + } + } + } + } + }, + "security" : [ ], + "summary" : "Retrieves the authentication configuration details and status information", + "tags" : [ "Authentication" ] + } + }, + "/connections/{id}" : { + "delete" : { + "operationId" : "deleteConnection", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ], + "summary" : "Deletes a connection", + "tags" : [ "Connections" ] + }, + "get" : { + "operationId" : "getConnection", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets a connection", + "tags" : [ "Connections" ] + }, + "put" : { + "operationId" : "updateConnection", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionEntity" + } + } + }, + "description" : "The connection configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + } ], + "summary" : "Updates a connection", + "tags" : [ "Connections" ] + } + }, + "/connectors" : { + "post" : { + "operationId" : "createConnector", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + }, + "description" : "The connector configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /connectors" : [ ] + } ], + "summary" : "Creates a new connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{connectorId}/flow/process-groups/{processGroupId}" : { + "get" : { + "description" : "Returns the flow for the specified process group within the connector's hierarchy. The processGroupId can be obtained from the managedProcessGroupId field of the ConnectorDTO for the root process group, or from child process groups within the flow. If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getFlow", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "connectorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "processGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether to return only UI-specific fields", + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the flow for a process group within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{connectorId}/flow/process-groups/{processGroupId}/controller-services" : { + "get" : { + "description" : "Returns the controller services for the specified process group within the connector's hierarchy. The processGroupId can be obtained from the managedProcessGroupId field of the ConnectorDTO for the root process group, or from child process groups within the flow.", + "operationId" : "getControllerServicesFromConnectorProcessGroup", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "connectorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "processGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether or not to include parent/ancestor process groups", + "in" : "query", + "name" : "includeAncestorGroups", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "description" : "Whether or not to include descendant process groups", + "in" : "query", + "name" : "includeDescendantGroups", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Whether or not to include services' referencing components in the response", + "in" : "query", + "name" : "includeReferencingComponents", + "schema" : { + "type" : "boolean", + "default" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets all controller services for a process group within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{connectorId}/flow/process-groups/{processGroupId}/parameter-context" : { + "get" : { + "description" : "Returns the parameter context (with effective parameters, including those inherited from other contexts) bound to the specified process group within the connector's hierarchy. Sensitive parameter values are masked. Returns 204 No Content if the process group has no bound parameter context.", + "operationId" : "getParameterContextForConnectorProcessGroup", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "connectorId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "processGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterContextEntity" + } + } + } + }, + "204" : { + "description" : "The specified process group has no bound parameter context." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the parameter context bound to a process group within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}" : { + "delete" : { + "operationId" : "deleteConnector", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Deletes a connector", + "tags" : [ "Connectors" ] + }, + "get" : { + "operationId" : "getConnector", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets a connector", + "tags" : [ "Connectors" ] + }, + "put" : { + "operationId" : "updateConnector", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + }, + "description" : "The connector configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Updates a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/apply-update" : { + "post" : { + "description" : "This will apply any pending configuration changes to the connector. The client can poll the connector endpoint to check when the update is complete.", + "operationId" : "applyConnectorUpdate", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + }, + "description" : "The connector configuration with revision.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Applies an update to a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/assets" : { + "get" : { + "description" : "Lists the assets that belong to the Connector with the given ID.", + "operationId" : "getAssets", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AssetsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Lists the assets that belong to the Connector with the given ID", + "tags" : [ "Connectors" ] + }, + "post" : { + "description" : "This endpoint will create a new Asset in the Connector. The Asset will be created with the given name and the contents of the file that is uploaded.", + "operationId" : "createAsset", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Filename", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "The contents of the asset", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AssetEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Creates a new Asset in the given Connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/assets/{assetId}" : { + "get" : { + "operationId" : "getAssetContent", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The asset id.", + "in" : "path", + "name" : "assetId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "byte" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Retrieves the content of the asset with the given id for a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/backlog-requests" : { + "post" : { + "description" : "This will initiate the process of determining the backlog for a Connector. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /connectors/{id}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /connectors/{id}/backlog-requests/{requestId}.", + "operationId" : "submitConnectorBacklogRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Initiates a request to determine the current backlog for a Connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/backlog-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled.", + "operationId" : "deleteConnectorBacklogRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Backlog Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Backlog Request with the given ID", + "tags" : [ "Connectors" ] + }, + "get" : { + "description" : "Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /connectors/{id}/backlog-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 the backlog once the request is complete.", + "operationId" : "getConnectorBacklogRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Backlog Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Backlog Request with the given ID", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/configuration-steps" : { + "get" : { + "operationId" : "getConnectorConfigurationSteps", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationStepNamesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets all configuration step names for a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/configuration-steps/{configurationStepName}" : { + "get" : { + "operationId" : "getConnectorConfigurationStep", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationStepEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets a specific configuration step by name for a connector", + "tags" : [ "Connectors" ] + }, + "put" : { + "operationId" : "updateConnectorConfigurationStep", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationStepEntity" + } + } + }, + "description" : "The configuration step configuration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationStepEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + }, { + "Read - any referenced Parameter Providers - /parameter-providers/{uuid}" : [ ] + }, { + "Read - /connectors/{uuid} when referencing Assets owned by the connector" : [ ] + } ], + "summary" : "Updates a specific configuration step by name for a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/configuration-steps/{configurationStepName}/property-groups/{propertyGroupName}/properties/{propertyName}/allowable-values" : { + "get" : { + "description" : "Gets the allowable values for a specific property that supports dynamic fetching of allowable values. The filter parameter can be used to narrow down the results based on the property's filtering logic.", + "operationId" : "getConnectorPropertyAllowableValues", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property group name.", + "in" : "path", + "name" : "propertyGroupName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "path", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Optional filter to narrow down the allowable values.", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorPropertyAllowableValuesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the allowable values for a specific property in a connector's configuration step", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/configuration-steps/{configurationStepName}/verify-config" : { + "post" : { + "description" : "This will initiate the process of verifying a given Connector Configuration Step. This may be a long-running task. As a result, this endpoint will immediately return a VerifyConnectorConfigStepRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /connectors/{connectorId}/configuration-steps/{stepName}/verify-config/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /connectors/{connectorId}/configuration-steps/{stepName}/verify-config/{requestId}.", + "operationId" : "submitConfigurationStepVerificationRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConnectorConfigStepRequestEntity" + } + } + }, + "description" : "The verify config request entity containing the configuration step to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConnectorConfigStepRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + }, { + "Read - any referenced Parameter Providers - /parameter-providers/{uuid}" : [ ] + }, { + "Read - /connectors/{uuid} when referencing Assets owned by the connector" : [ ] + } ], + "summary" : "Performs verification of a configuration step for a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/configuration-steps/{configurationStepName}/verify-config/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteConfigurationStepVerificationRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConnectorConfigStepRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "Connectors" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once a Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.", + "operationId" : "getConfigurationStepVerificationRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name.", + "in" : "path", + "name" : "configurationStepName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConnectorConfigStepRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/connections/{connectionId}/status/history" : { + "get" : { + "operationId" : "getConnectorConnectionStatusHistory", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The connection id.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the status history for a connection within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/controller-services/{controllerServiceId}" : { + "get" : { + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getConnectorControllerService", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The controller service id.", + "in" : "path", + "name" : "controllerServiceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets a controller service within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/controller-services/{controllerServiceId}/state" : { + "get" : { + "operationId" : "getConnectorControllerServiceState", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The controller service id.", + "in" : "path", + "name" : "controllerServiceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a controller service within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/controller-services/{controllerServiceId}/state/clear-requests" : { + "post" : { + "operationId" : "clearConnectorControllerServiceState", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The controller service id.", + "in" : "path", + "name" : "controllerServiceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a controller service within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/drain" : { + "delete" : { + "operationId" : "cancelDrain", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid} or /operation/connectors/{uuid}" : [ ] + } ], + "summary" : "Cancels the draining of FlowFiles for a connector", + "tags" : [ "Connectors" ] + }, + "post" : { + "description" : "This will initiate draining of FlowFiles for a stopped connector. Draining allows the connector to process data that is currently in the flow but does not ingest any additional data. The connector must be in a STOPPED state before draining can begin. Once initiated, the connector will transition to a DRAINING state. Use the DELETE method on this endpoint to cancel an ongoing drain operation.", + "operationId" : "initiateDrain", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + }, + "description" : "The connector entity with revision.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid} or /operation/connectors/{uuid}" : [ ] + } ], + "summary" : "Initiates draining of FlowFiles for a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/migration-payloads" : { + "post" : { + "operationId" : "createMigrationPayload", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "The migration payload snapshot", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MigrationPayloadEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Uploads a flow snapshot payload for a later Connector migration request", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/migration-requests" : { + "post" : { + "operationId" : "createMigrationRequest", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MigrationRequestEntity" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MigrationRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid} - For a migration from a local Process Group" : [ ] + } ], + "summary" : "Creates a Connector migration request", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/migration-requests/{requestId}" : { + "delete" : { + "operationId" : "deleteMigrationRequest", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MigrationRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "summary" : "Deletes the Connector migration request with the given ID", + "tags" : [ "Connectors" ] + }, + "get" : { + "operationId" : "getMigrationRequest", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MigrationRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "summary" : "Gets the Connector migration request with the given ID", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/migration-sources" : { + "get" : { + "operationId" : "getMigrationSources", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowMigrationSourcesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid} - For each Process Group returned" : [ ] + } ], + "summary" : "Lists the Versioned Process Groups that the Connector can be migrated from", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/process-groups/{processGroupId}/status/history" : { + "get" : { + "operationId" : "getConnectorProcessGroupStatusHistory", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "processGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the status history for a process group within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/processors/{processorId}/state" : { + "get" : { + "operationId" : "getConnectorProcessorState", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "processorId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a processor within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/processors/{processorId}/state/clear-requests" : { + "post" : { + "operationId" : "clearConnectorProcessorState", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "processorId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a processor within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/processors/{processorId}/status/history" : { + "get" : { + "operationId" : "getConnectorProcessorStatusHistory", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "processorId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the status history for a processor within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/purge-requests" : { + "post" : { + "description" : "This will create a request to purge all FlowFiles from the connector. The connector must be in a STOPPED state before purging can begin. This is an asynchronous operation. The client should poll the returned URI to get the status of the purge request.", + "operationId" : "createPurgeRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DropRequestEntity" + } + } + }, + "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." + } + }, + "security" : [ { + "Write Source Data - /data/connectors/{uuid}" : [ ] + } ], + "summary" : "Creates a request to purge the FlowFiles for this connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/purge-requests/{purge-request-id}" : { + "delete" : { + "operationId" : "removePurgeRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The purge request id.", + "in" : "path", + "name" : "purge-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Cancels and/or removes a request to purge the FlowFiles for this connector", + "tags" : [ "Connectors" ] + }, + "get" : { + "operationId" : "getPurgeRequest", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The purge request id.", + "in" : "path", + "name" : "purge-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Gets the current status of a purge request for the specified connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/remote-process-groups/{remoteProcessGroupId}/status/history" : { + "get" : { + "operationId" : "getConnectorRemoteProcessGroupStatusHistory", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group id.", + "in" : "path", + "name" : "remoteProcessGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the status history for a remote process group within a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorRunStatusEntity" + } + } + }, + "description" : "The connector run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid} or /operation/connectors/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/search-results" : { + "get" : { + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchConnector", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The search term.", + "in" : "query", + "name" : "q", + "schema" : { + "type" : "string", + "default" : "" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Performs a search against the encapsulated process group of this connector using the specified search term", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/secrets" : { + "get" : { + "description" : "Returns metadata for all secrets available from all secret providers. This endpoint is used when configuring a connector to discover available secrets. Note: Actual secret values are not included in the response for security reasons.", + "operationId" : "getSecrets", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SecretsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets all secrets available for configuring a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/status" : { + "get" : { + "description" : "Returns the status for the process group managed by the specified connector. The status includes status for all descendent components. When invoked with recursive set to true, it will return the current status of every component in the connector's encapsulated flow.", + "operationId" : "getConnectorStatus", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "in" : "query", + "name" : "recursive", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /connectors/{uuid}" : [ ] + } ], + "summary" : "Gets the status for the process group managed by a connector", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/troubleshooting" : { + "delete" : { + "description" : "Ends Troubleshooting mode for the Connector, restoring the authoritative flow. All components in the managed flow must be stopped and disabled, and the managed flow must have no active tasks.", + "operationId" : "endTroubleshooting", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid} or /operation/connectors/{uuid}" : [ ] + } ], + "summary" : "Transitions a Connector out of Troubleshooting mode", + "tags" : [ "Connectors" ] + }, + "post" : { + "description" : "Places the Connector into Troubleshooting mode so that its managed flow may be directly modified. Standard lifecycle operations are disabled while in Troubleshooting mode.", + "operationId" : "enterTroubleshooting", + "parameters" : [ { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + }, + "description" : "The connector entity with revision.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid} or /operation/connectors/{uuid}" : [ ] + } ], + "summary" : "Transitions a Connector into Troubleshooting mode", + "tags" : [ "Connectors" ] + } + }, + "/connectors/{id}/working-configuration" : { + "delete" : { + "description" : "This will discard any pending configuration changes for the connector and revert to the last applied configuration.", + "operationId" : "discardConnectorUpdate", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The connector id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /connectors/{uuid}" : [ ] + } ], + "summary" : "Discards the working configuration of a connector", + "tags" : [ "Connectors" ] + } + }, + "/controller-services/{id}" : { + "delete" : { + "operationId" : "removeControllerService", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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}" : [ ] + } ], + "summary" : "Deletes a controller service", + "tags" : [ "Controller Services" ] + }, + "get" : { + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerService", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Gets a controller service", + "tags" : [ "Controller Services" ] + }, + "put" : { + "operationId" : "updateControllerService", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerServiceEntity" + } + } + }, + "description" : "The controller service configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates a controller service", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The clear bulletin request specifying the timestamp from which to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a controller service", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeConfiguration", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/config/verification-requests" : { + "post" : { + "description" : "This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The controller service configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Controller Service's configuration", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Controller Service", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "Controller Services" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Controller Service", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "operationId" : "getPropertyDescriptor_1", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name to return the descriptor for.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property Descriptor requested sensitive status", + "in" : "query", + "name" : "sensitive", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Gets a controller service property descriptor", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "operationId" : "getControllerServiceReferences", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Gets a controller service", + "tags" : [ "Controller Services" ] + }, + "put" : { + "operationId" : "updateControllerServiceReferences", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateControllerServiceReferenceRequestEntity" + } + } + }, + "description" : "The controller service request update request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ], + "summary" : "Updates a controller services references", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_2", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerServiceRunStatusEntity" + } + } + }, + "description" : "The controller service run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a controller service", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "operationId" : "getState", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a controller service", + "tags" : [ "Controller Services" ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "operationId" : "clearState_1", + "parameters" : [ { + "description" : "The controller service id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a controller service", + "tags" : [ "Controller Services" ] + } + }, + "/controller/bulletin" : { + "post" : { + "operationId" : "createBulletin", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + } + }, + "description" : "The reporting task configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Creates a new bulletin", + "tags" : [ "Controller" ] + } + }, + "/controller/cluster" : { + "get" : { + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Gets the contents of the cluster", + "tags" : [ "Controller" ] + } + }, + "/controller/cluster/nodes/{id}" : { + "delete" : { + "operationId" : "deleteNode", + "parameters" : [ { + "description" : "The node id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Removes a node from the cluster", + "tags" : [ "Controller" ] + }, + "get" : { + "operationId" : "getNode", + "parameters" : [ { + "description" : "The node id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Gets a node in the cluster", + "tags" : [ "Controller" ] + }, + "put" : { + "operationId" : "updateNode", + "parameters" : [ { + "description" : "The node id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NodeEntity" + } + } + }, + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Updates a node in the cluster", + "tags" : [ "Controller" ] + } + }, + "/controller/config" : { + "get" : { + "operationId" : "getControllerConfig", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "tags" : [ "Controller" ] + }, + "put" : { + "operationId" : "updateControllerConfig", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerConfigurationEntity" + } + } + }, + "description" : "The controller configuration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Updates the configuration for this NiFi", + "tags" : [ "Controller" ] + } + }, + "/controller/controller-services" : { + "post" : { + "operationId" : "createControllerService", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerServiceEntity" + } + } + }, + "description" : "The controller service configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new controller service", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules" : { + "get" : { + "operationId" : "getFlowAnalysisRules", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRulesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all flow analysis rules", + "tags" : [ "Controller" ] + }, + "post" : { + "operationId" : "createFlowAnalysisRule", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + }, + "description" : "The flow analysis rule configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}" : { + "delete" : { + "operationId" : "removeFlowAnalysisRule", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Deletes a flow analysis rule", + "tags" : [ "Controller" ] + }, + "get" : { + "operationId" : "getFlowAnalysisRule", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Gets a flow analysis rule", + "tags" : [ "Controller" ] + }, + "put" : { + "operationId" : "updateFlowAnalysisRule", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + }, + "description" : "The flow analysis rule configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates a flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearFlowAnalysisRuleBulletins", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The request to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeFlowAnalysisRuleConfiguration", + "parameters" : [ { + "description" : "The flow analysis rules id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/config/verification-requests" : { + "post" : { + "description" : "This will initiate the process of verifying a given Flow Analysis Rule configuration. This may be a long-running task. As a result, this endpoint will immediately return a FlowAnalysisRuleConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /flow-analysis-rules/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /flow-analysis-rules/{serviceId}/verification-requests/{requestId}.", + "operationId" : "submitFlowAnalysisRuleConfigVerificationRequest", + "parameters" : [ { + "description" : "The flow analysis rules id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The flow analysis rules configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Write - /flow-analysis-rules/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Flow Analysis Rule's configuration", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteFlowAnalysisRuleVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Flow Analysis Rule", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "Controller" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getFlowAnalysisRuleVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Flow Analysis Rule", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/descriptors" : { + "get" : { + "operationId" : "getFlowAnalysisRulePropertyDescriptor", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property Descriptor requested sensitive status", + "in" : "query", + "name" : "sensitive", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Gets a flow analysis rule property descriptor", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_1", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleRunStatusEntity" + } + } + }, + "description" : "The flow analysis rule run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid} or or /operation/flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/state" : { + "get" : { + "operationId" : "getFlowAnalysisRuleState", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/flow-analysis-rules/{id}/state/clear-requests" : { + "post" : { + "operationId" : "clearState", + "parameters" : [ { + "description" : "The flow analysis rule id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /flow-analysis-rules/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a flow analysis rule", + "tags" : [ "Controller" ] + } + }, + "/controller/history" : { + "delete" : { + "operationId" : "deleteHistory", + "parameters" : [ { + "description" : "Purge actions before this date/time.", + "in" : "query", + "name" : "endDate", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/DateTimeParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Purges history", + "tags" : [ "Controller" ] + } + }, + "/controller/nar-manager/nars" : { + "get" : { + "operationId" : "getNarSummaries", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NarSummariesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves summary information for installed NARs", + "tags" : [ "Controller" ] + } + }, + "/controller/nar-manager/nars/content" : { + "post" : { + "operationId" : "uploadNar", + "parameters" : [ { + "in" : "header", + "name" : "Filename", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "The contents of the NAR file.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NarSummaryEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Uploads a NAR and requests for it to be installed", + "tags" : [ "Controller" ] + } + }, + "/controller/nar-manager/nars/{id}" : { + "delete" : { + "operationId" : "deleteNar", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Indicates if the NAR should be deleted even when components are instantiated.", + "in" : "query", + "name" : "force", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the NAR.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NarSummaryEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Deletes an installed NAR", + "tags" : [ "Controller" ] + }, + "get" : { + "operationId" : "getNarSummary", + "parameters" : [ { + "description" : "The id of the NAR.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NarDetailsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves the summary information for the NAR with the given identifier", + "tags" : [ "Controller" ] + } + }, + "/controller/nar-manager/nars/{id}/content" : { + "get" : { + "operationId" : "downloadNar", + "parameters" : [ { + "description" : "The id of the NAR.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "byte" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves the content of the NAR with the given id", + "tags" : [ "Controller" ] + } + }, + "/controller/nar-manager/nars/{id}/details" : { + "get" : { + "operationId" : "getNarDetails", + "parameters" : [ { + "description" : "The id of the NAR.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/NarDetailsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves the component types available from the installed NARs", + "tags" : [ "Controller" ] + } + }, + "/controller/parameter-providers" : { + "post" : { + "operationId" : "createParameterProvider", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + }, + "description" : "The parameter provider configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new parameter provider", + "tags" : [ "Controller" ] + } + }, + "/controller/parameter-providers/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearParameterProviderBulletins", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The request to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a parameter provider", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients" : { + "get" : { + "operationId" : "getFlowRegistryClients", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Gets the listing of available flow registry clients", + "tags" : [ "Controller" ] + }, + "post" : { + "operationId" : "createFlowRegistryClient", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + }, + "description" : "The flow registry client configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + }, { + "Write - /controller" : [ ] + } ], + "summary" : "Creates a new flow registry client", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}" : { + "delete" : { + "operationId" : "deleteFlowRegistryClient", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The flow registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller/registry-clients/{id}" : [ ] + } ], + "summary" : "Deletes a flow registry client", + "tags" : [ "Controller" ] + }, + "get" : { + "operationId" : "getFlowRegistryClient", + "parameters" : [ { + "description" : "The flow registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /controller/registry-clients/{id}" : [ ] + } ], + "summary" : "Gets a flow registry client", + "tags" : [ "Controller" ] + }, + "put" : { + "operationId" : "updateFlowRegistryClient", + "parameters" : [ { + "description" : "The flow registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + }, + "description" : "The flow registry client configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller/registry-clients/{id}" : [ ] + } ], + "summary" : "Updates a flow registry client", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearRegistryClientBulletins", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The request to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller/registry-clients/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a registry client", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeFlowRegistryClientConfiguration", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}/config/verification-requests" : { + "post" : { + "description" : "Initiates verification of a Registry Client configuration. The request returns immediately with a request entity while verification runs asynchronously. The client should poll /controller/registry-clients/{clientId}/config/verification-requests/{requestId} for status and DELETE the request once verification completes.", + "operationId" : "submitRegistryClientConfigVerificationRequest", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The registry client configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /controller/registry-clients/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Registry Client's configuration", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteRegistryClientVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Registry Client", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "Controller" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once a Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getRegistryClientVerificationRequest", + "parameters" : [ { + "description" : "The ID of the Registry Client", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-clients/{id}/descriptors" : { + "get" : { + "operationId" : "getPropertyDescriptor", + "parameters" : [ { + "description" : "The flow registry client id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property Descriptor requested sensitive status", + "in" : "query", + "name" : "sensitive", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller/registry-clients/{id}" : [ ] + } ], + "summary" : "Gets a flow registry client property descriptor", + "tags" : [ "Controller" ] + } + }, + "/controller/registry-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getRegistryClientTypes", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientTypesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Retrieves the types of flow registry clients that this NiFi supports", + "tags" : [ "Controller" ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "operationId" : "createReportingTask", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReportingTaskEntity" + } + } + }, + "description" : "The reporting task configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new reporting task", + "tags" : [ "Controller" ] + } + }, + "/controller/reporting-tasks/import" : { + "post" : { + "operationId" : "importReportingTaskSnapshot", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedReportingTaskImportRequestEntity" + } + } + }, + "description" : "The import request containing the reporting task snapshot to import.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedReportingTaskImportResponseEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ], + "summary" : "Imports a reporting task snapshot", + "tags" : [ "Controller" ] + } + }, + "/controller/status/history" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getNodeStatusHistory", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ], + "summary" : "Gets status history for the node", + "tags" : [ "Controller" ] + } + }, + "/counters" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ], + "summary" : "Gets the current counters for this NiFi", + "tags" : [ "Counters" ] + }, + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateAllCounters", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ], + "summary" : "Updates all counters. This will reset all counter values to 0", + "tags" : [ "Counters" ] + } + }, + "/counters/{id}" : { + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "parameters" : [ { + "description" : "The id of the counter.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "tags" : [ "Counters" ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "delete" : { + "operationId" : "commitInputPortTransaction", + "parameters" : [ { + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "in" : "query", + "name" : "responseCode", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "description" : "The input port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "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}" : [ ] + } ], + "summary" : "Commit or cancel the specified transaction", + "tags" : [ "DataTransfer" ] + }, + "put" : { + "operationId" : "extendInputPortTransactionTTL", + "parameters" : [ { + "description" : "The input port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ], + "summary" : "Extend transaction TTL", + "tags" : [ "DataTransfer" ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "operationId" : "receiveFlowFiles", + "parameters" : [ { + "description" : "The input port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "202" : { + "content" : { + "text/plain" : { + "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." + }, + "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}" : [ ] + } ], + "summary" : "Transfer FlowFiles to the input port", + "tags" : [ "DataTransfer" ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "delete" : { + "operationId" : "commitOutputPortTransaction", + "parameters" : [ { + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "in" : "query", + "name" : "responseCode", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "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.", + "in" : "query", + "name" : "checksum", + "required" : true, + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "description" : "The output port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "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}" : [ ] + } ], + "summary" : "Commit or cancel the specified transaction", + "tags" : [ "DataTransfer" ] + }, + "put" : { + "operationId" : "extendOutputPortTransactionTTL", + "parameters" : [ { + "description" : "The output port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "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}" : [ ] + } ], + "summary" : "Extend transaction TTL", + "tags" : [ "DataTransfer" ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "operationId" : "transferFlowFiles", + "parameters" : [ { + "description" : "The output port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The transaction id.", + "in" : "path", + "name" : "transactionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "200" : { + "description" : "There is no flow file to return." + }, + "202" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "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}" : [ ] + } ], + "summary" : "Transfer FlowFiles from the output port", + "tags" : [ "DataTransfer" ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "operationId" : "createPortTransaction", + "parameters" : [ { + "description" : "The port type.", + "in" : "path", + "name" : "portType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The input or output port id.", + "in" : "path", + "name" : "portId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + } + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "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}" : [ ] + } ], + "summary" : "Create a transaction to the specified output port or input port", + "tags" : [ "DataTransfer" ] + } + }, + "/flow/about" : { + "get" : { + "operationId" : "getAboutInfo", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "tags" : [ "Flow" ] + } + }, + "/flow/additional-details/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAdditionalDetails", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdditionalDetailsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The additional details for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the additional details for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/banners" : { + "get" : { + "operationId" : "getBanners", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the banners for this NiFi", + "tags" : [ "Flow" ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "operationId" : "getBulletinBoard", + "parameters" : [ { + "description" : "Includes bulletins with an id after this value.", + "in" : "query", + "name" : "after", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "in" : "query", + "name" : "sourceName", + "schema" : { + "$ref" : "#/components/schemas/BulletinBoardPatternParameter" + } + }, { + "description" : "Includes bulletins whose message that match this regular expression.", + "in" : "query", + "name" : "message", + "schema" : { + "$ref" : "#/components/schemas/BulletinBoardPatternParameter" + } + }, { + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "in" : "query", + "name" : "sourceId", + "schema" : { + "$ref" : "#/components/schemas/BulletinBoardPatternParameter" + } + }, { + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "in" : "query", + "name" : "groupId", + "schema" : { + "$ref" : "#/components/schemas/BulletinBoardPatternParameter" + } + }, { + "description" : "The number of bulletins to limit the response to. Optional, default is no limit.", + "in" : "query", + "name" : "limit", + "schema" : { + "$ref" : "#/components/schemas/IntegerParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ], + "summary" : "Gets current bulletins", + "tags" : [ "Flow" ] + } + }, + "/flow/client-id" : { + "get" : { + "operationId" : "generateClientId", + "responses" : { + "200" : { + "content" : { + "text/plain" : { + "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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Generates a client id.", + "tags" : [ "Flow" ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "parameters" : [ { + "description" : "Node address to search for.", + "in" : "query", + "name" : "q", + "required" : true, + "schema" : { + "type" : "string", + "default" : "" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Searches the cluster for a node with the specified address", + "tags" : [ "Flow" ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "operationId" : "getClusterSummary", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSummaryEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "The cluster summary for this NiFi", + "tags" : [ "Flow" ] + } + }, + "/flow/config" : { + "get" : { + "operationId" : "getFlowConfig", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the configuration for this NiFi flow", + "tags" : [ "Flow" ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "operationId" : "getConnectionStatistics", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the statistics.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets statistics for a connection", + "tags" : [ "Flow" ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "operationId" : "getConnectionStatus", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status for a connection", + "tags" : [ "Flow" ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "operationId" : "getConnectionStatusHistory", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the status history for a connection", + "tags" : [ "Flow" ] + } + }, + "/flow/connector-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getConnectorDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The connector type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The connector definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Connector Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/connector-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getConnectorTypes", + "parameters" : [ { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorTypesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of connectors that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/connectors" : { + "get" : { + "operationId" : "getConnectors", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectorsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all connectors", + "tags" : [ "Flow" ] + } + }, + "/flow/content-viewers" : { + "get" : { + "operationId" : "getContentViewers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ContentViewerEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the registered content viewers", + "tags" : [ "Flow" ] + } + }, + "/flow/controller-service-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The controller service type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerServiceDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The controller service definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Controller Service Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "parameters" : [ { + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "in" : "query", + "name" : "serviceType", + "schema" : { + "type" : "string" + } + }, { + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "in" : "query", + "name" : "serviceBundleGroup", + "schema" : { + "type" : "string" + } + }, { + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "in" : "query", + "name" : "serviceBundleArtifact", + "schema" : { + "type" : "string" + } + }, { + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "in" : "query", + "name" : "serviceBundleVersion", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "typeFilter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "operationId" : "getBulletins", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ], + "summary" : "Retrieves Controller level bulletins", + "tags" : [ "Flow" ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerServicesFromController", + "parameters" : [ { + "description" : "Whether or not to include services' referencing components in the response", + "in" : "query", + "name" : "includeReferencingComponents", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets controller services for reporting tasks", + "tags" : [ "Flow" ] + } + }, + "/flow/current-user" : { + "get" : { + "operationId" : "getCurrentUser", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CurrentUserEntity" + } + } + } + } + }, + "summary" : "Retrieves the user identity of the user making the request", + "tags" : [ "Flow" ] + } + }, + "/flow/flow-analysis-rule-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getFlowAnalysisRuleDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow analysis rule type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The flow analysis rule definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Flow Analysis Rule Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/flow-analysis-rule-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getFlowAnalysisRuleTypes", + "parameters" : [ { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleTypesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of available Flow Analysis Rules", + "tags" : [ "Flow" ] + } + }, + "/flow/flow-analysis/results" : { + "get" : { + "operationId" : "getAllFlowAnalysisResults", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Returns all flow analysis results currently in effect", + "tags" : [ "Flow" ] + } + }, + "/flow/flow-analysis/results/{processGroupId}" : { + "get" : { + "operationId" : "getFlowAnalysisResults", + "parameters" : [ { + "description" : "The id of the process group representing (a part of) the flow to be analyzed.", + "in" : "path", + "name" : "processGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowAnalysisResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Returns flow analysis results produced by the analysis of a given process group", + "tags" : [ "Flow" ] + } + }, + "/flow/flow-registry-client-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getFlowRegistryClientDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow registry client type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The flow registry client definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Flow Registry Client Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/history" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "parameters" : [ { + "description" : "The offset into the result set.", + "in" : "query", + "name" : "offset", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/IntegerParameter" + } + }, { + "description" : "The number of actions to return.", + "in" : "query", + "name" : "count", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/IntegerParameter" + } + }, { + "description" : "The field to sort on.", + "in" : "query", + "name" : "sortColumn", + "schema" : { + "type" : "string" + } + }, { + "description" : "The direction to sort.", + "in" : "query", + "name" : "sortOrder", + "schema" : { + "type" : "string" + } + }, { + "description" : "Include actions after this date.", + "in" : "query", + "name" : "startDate", + "schema" : { + "$ref" : "#/components/schemas/DateTimeParameter" + } + }, { + "description" : "Include actions before this date.", + "in" : "query", + "name" : "endDate", + "schema" : { + "$ref" : "#/components/schemas/DateTimeParameter" + } + }, { + "description" : "Include actions performed by this user.", + "in" : "query", + "name" : "userIdentity", + "schema" : { + "type" : "string" + } + }, { + "description" : "Include actions on this component.", + "in" : "query", + "name" : "sourceId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets configuration history", + "tags" : [ "Flow" ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "parameters" : [ { + "description" : "The component id.", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets configuration history for a component", + "tags" : [ "Flow" ] + } + }, + "/flow/history/{id}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "parameters" : [ { + "description" : "The action id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/IntegerParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets an action", + "tags" : [ "Flow" ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "operationId" : "getInputPortStatus", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The input port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status for an input port", + "tags" : [ "Flow" ] + } + }, + "/flow/listen-ports" : { + "get" : { + "operationId" : "getListenPorts", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListenPortsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all listen ports configured on this NiFi that the current user has access to", + "tags" : [ "Flow" ] + } + }, + "/flow/metrics/{producer}" : { + "get" : { + "operationId" : "getFlowMetrics", + "parameters" : [ { + "description" : "The producer for flow file metrics. Each producer may have its own output format.", + "in" : "path", + "name" : "producer", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PROMETHEUS", "JSON" ] + } + }, { + "description" : "Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default.", + "in" : "query", + "name" : "includedRegistries", + "schema" : { + "type" : "string", + "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION", "CLUSTER", "VERSION_INFO" ] + } + }, { + "description" : "Regular Expression Pattern to be applied against the sample name field", + "in" : "query", + "name" : "sampleName", + "schema" : { + "type" : "string" + } + }, { + "description" : "Regular Expression Pattern to be applied against the sample label value field", + "in" : "query", + "name" : "sampleLabelValue", + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", + "in" : "query", + "name" : "rootFieldName", + "schema" : { + "type" : "string" + } + }, { + "description" : "Flow metrics reporting strategy limits collected metrics", + "in" : "query", + "name" : "flowMetricsReportingStrategy", + "schema" : { + "type" : "string", + "default" : "ALL_COMPONENTS", + "enum" : [ "ALL_PROCESS_GROUPS", "ALL_COMPONENTS" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all metrics for the flow from a particular node", + "tags" : [ "Flow" ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "operationId" : "getOutputPortStatus", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The output port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status for an output port", + "tags" : [ "Flow" ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "operationId" : "getParameterContexts", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ], + "summary" : "Gets all Parameter Contexts", + "tags" : [ "Flow" ] + } + }, + "/flow/parameter-provider-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getParameterProviderDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The parameter provider type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The reporting task definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Parameter Provider Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/parameter-provider-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getParameterProviderTypes", + "parameters" : [ { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderTypesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of parameter providers that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/parameter-providers" : { + "get" : { + "operationId" : "getParameterProviders", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProvidersEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all parameter providers", + "tags" : [ "Flow" ] + } + }, + "/flow/prioritizers" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getFlow_1", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets a process group", + "tags" : [ "Flow" ] + }, + "put" : { + "operationId" : "scheduleComponents", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ScheduleComponentsEntity" + } + } + }, + "description" : "The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}/breadcrumbs" : { + "get" : { + "operationId" : "getBreadcrumbs", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowBreadcrumbEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the breadcrumbs for a process group", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_1", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsForGroupRequestEntity" + } + } + }, + "description" : "The request to clear bulletins. If the components in the request are not specified, all authorized components will be considered.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsForGroupResultsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /process-groups/{uuid} - For the process group" : [ ] + }, { + "Write - /{component-type}/{uuid} - For every component having bulletins cleared" : [ ] + } ], + "summary" : "Clears bulletins for components in the specified Process Group.", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerServicesFromGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether or not to include parent/ancestor process groups", + "in" : "query", + "name" : "includeAncestorGroups", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "description" : "Whether or not to include descendant process groups", + "in" : "query", + "name" : "includeDescendantGroups", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Whether or not to include services' referencing components in the response", + "in" : "query", + "name" : "includeReferencingComponents", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "in" : "query", + "name" : "uiOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all controller services", + "tags" : [ "Flow" ] + }, + "put" : { + "operationId" : "activateControllerServices", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActivateControllerServicesEntity" + } + } + }, + "description" : "The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "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", + "parameters" : [ { + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "in" : "query", + "name" : "recursive", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the status for a process group", + "tags" : [ "Flow" ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "operationId" : "getProcessGroupStatusHistory", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status history for a remote process group", + "tags" : [ "Flow" ] + } + }, + "/flow/processor-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessorDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The processor definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Processor Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/processor-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "parameters" : [ { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "operationId" : "getProcessorStatus", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status for a processor", + "tags" : [ "Flow" ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "operationId" : "getProcessorStatusHistory", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status history for a processor", + "tags" : [ "Flow" ] + } + }, + "/flow/registries" : { + "get" : { + "operationId" : "getRegistryClients", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryClientsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the listing of available flow registry clients", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{id}/branches" : { + "get" : { + "operationId" : "getBranches", + "parameters" : [ { + "description" : "The registry id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryBranchesEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the branches from the specified registry for the current user", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "operationId" : "getBuckets", + "parameters" : [ { + "description" : "The registry id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used.", + "in" : "query", + "name" : "branch", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FlowRegistryBucketsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the buckets from the specified registry for the current user", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{registry-id}/branches/{branch-id-a}/buckets/{bucket-id-a}/flows/{flow-id-a}/{version-a}/diff/branches/{branch-id-b}/buckets/{bucket-id-b}/flows/{flow-id-b}/{version-b}" : { + "get" : { + "operationId" : "getVersionDifferences", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "registry-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The branch id for the base version.", + "in" : "path", + "name" : "branch-id-a", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bucket id for the base version.", + "in" : "path", + "name" : "bucket-id-a", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow id for the base version.", + "in" : "path", + "name" : "flow-id-a", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The base version.", + "in" : "path", + "name" : "version-a", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The branch id for the compared version.", + "in" : "path", + "name" : "branch-id-b", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bucket id for the compared version.", + "in" : "path", + "name" : "bucket-id-b", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow id for the compared version.", + "in" : "path", + "name" : "flow-id-b", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The compared version.", + "in" : "path", + "name" : "version-b", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.", + "in" : "query", + "name" : "offset", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "description" : "Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.", + "in" : "query", + "name" : "limit", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "operationId" : "getFlows", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "registry-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bucket id.", + "in" : "path", + "name" : "bucket-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The name of a branch to get the flows from. If not specified the default branch of the registry client will be used.", + "in" : "query", + "name" : "branch", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { + "get" : { + "operationId" : "getDetails", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "registry-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bucket id.", + "in" : "path", + "name" : "bucket-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow id.", + "in" : "path", + "name" : "flow-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The name of a branch to get the flow from. If not specified the default branch of the registry client will be used.", + "in" : "query", + "name" : "branch", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", + "tags" : [ "Flow" ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "operationId" : "getVersions", + "parameters" : [ { + "description" : "The registry client id.", + "in" : "path", + "name" : "registry-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bucket id.", + "in" : "path", + "name" : "bucket-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow id.", + "in" : "path", + "name" : "flow-id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used.", + "in" : "query", + "name" : "branch", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "tags" : [ "Flow" ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "operationId" : "getRemoteProcessGroupStatus", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets status for a remote process group", + "tags" : [ "Flow" ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "operationId" : "getRemoteProcessGroupStatusHistory", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the status history", + "tags" : [ "Flow" ] + } + }, + "/flow/reporting-task-definition/{group}/{artifact}/{version}/{type}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskDefinition", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The reporting task type", + "in" : "path", + "name" : "type", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReportingTaskDefinition" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The reporting task definition for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the Reporting Task Definition for the specified component type.", + "tags" : [ "Flow" ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "parameters" : [ { + "description" : "If specified, will only return types that are a member of this bundle group.", + "in" : "query", + "name" : "bundleGroupFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "in" : "query", + "name" : "bundleArtifactFilter", + "schema" : { + "type" : "string" + } + }, { + "description" : "If specified, will only return types whose fully qualified classname matches.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "tags" : [ "Flow" ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "operationId" : "getReportingTasks", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets all reporting tasks", + "tags" : [ "Flow" ] + } + }, + "/flow/reporting-tasks/download" : { + "get" : { + "operationId" : "downloadReportingTaskSnapshot", + "parameters" : [ { + "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", + "in" : "query", + "name" : "reportingTaskId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string", + "format" : "byte" + } + } + } + }, + "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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Download a snapshot of the given reporting tasks and any controller services they use", + "tags" : [ "Flow" ] + } + }, + "/flow/reporting-tasks/snapshot" : { + "get" : { + "operationId" : "getReportingTaskSnapshot", + "parameters" : [ { + "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", + "in" : "query", + "name" : "reportingTaskId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedReportingTaskSnapshot" + } + } + } + }, + "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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Get a snapshot of the given reporting tasks and any controller services they use", + "tags" : [ "Flow" ] + } + }, + "/flow/runtime-manifest" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getRuntimeManifest", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RuntimeManifestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the runtime manifest for this NiFi instance.", + "tags" : [ "Flow" ] + } + }, + "/flow/search-results" : { + "get" : { + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "parameters" : [ { + "description" : "The search term.", + "in" : "query", + "name" : "q", + "schema" : { + "type" : "string", + "default" : "" + } + }, { + "description" : "The id of the currently visited process group. If not specified, then the root process group is used.", + "in" : "query", + "name" : "a", + "schema" : { + "type" : "string", + "default" : "" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Performs a search against this NiFi using the specified search term", + "tags" : [ "Flow" ] + } + }, + "/flow/status" : { + "get" : { + "operationId" : "getControllerStatus", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Gets the current status of this NiFi", + "tags" : [ "Flow" ] + } + }, + "/flow/steps/{group}/{artifact}/{version}/{connectorType}/{stepName}" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getStepDocumentation", + "parameters" : [ { + "description" : "The bundle group", + "in" : "path", + "name" : "group", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle artifact", + "in" : "path", + "name" : "artifact", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The bundle version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified Connector type", + "in" : "path", + "name" : "connectorType", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The configuration step name", + "in" : "path", + "name" : "stepName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StepDocumentationEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The step documentation for the coordinates could not be located." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ], + "summary" : "Retrieves the step documentation for the specified Connector configuration step.", + "tags" : [ "Flow" ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "operationId" : "createDropRequest", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DropRequestEntity" + } + } + }, + "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." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "delete" : { + "operationId" : "removeDropRequest", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The drop request id.", + "in" : "path", + "name" : "drop-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "tags" : [ "FlowFileQueues" ] + }, + "get" : { + "operationId" : "getDropRequest", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The drop request id.", + "in" : "path", + "name" : "drop-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "operationId" : "getFlowFile", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The FlowFile uuid.", + "in" : "path", + "name" : "flowfile-uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the node where the content exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets a FlowFile from a Connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "operationId" : "downloadFlowFileContent", + "parameters" : [ { + "description" : "Range of bytes requested", + "in" : "header", + "name" : "Range", + "schema" : { + "type" : "string" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The FlowFile uuid.", + "in" : "path", + "name" : "flowfile-uuid", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the node where the content exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingOutput" + } + } + } + }, + "206" : { + "description" : "Partial Content with range of bytes requested" + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + }, + "416" : { + "description" : "Requested Range Not Satisfiable based on bytes requested" + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "operationId" : "createFlowFileListing", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListingRequestEntity" + } + } + }, + "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." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Lists the contents of the queue in this connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "delete" : { + "operationId" : "deleteListingRequest", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The listing request id.", + "in" : "path", + "name" : "listing-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "tags" : [ "FlowFileQueues" ] + }, + "get" : { + "operationId" : "getListingRequest", + "parameters" : [ { + "description" : "The connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The listing request id.", + "in" : "path", + "name" : "listing-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "tags" : [ "FlowFileQueues" ] + } + }, + "/funnels/{id}" : { + "delete" : { + "operationId" : "removeFunnel", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The funnel id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes a funnel", + "tags" : [ "Funnels" ] + }, + "get" : { + "operationId" : "getFunnel", + "parameters" : [ { + "description" : "The funnel id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ], + "summary" : "Gets a funnel", + "tags" : [ "Funnels" ] + }, + "put" : { + "operationId" : "updateFunnel", + "parameters" : [ { + "description" : "The funnel id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FunnelEntity" + } + } + }, + "description" : "The funnel configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ], + "summary" : "Updates a funnel", + "tags" : [ "Funnels" ] + } + }, + "/input-ports/{id}" : { + "delete" : { + "operationId" : "removeInputPort", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The input port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes an input port", + "tags" : [ "InputPorts" ] + }, + "get" : { + "operationId" : "getInputPort", + "parameters" : [ { + "description" : "The input port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ], + "summary" : "Gets an input port", + "tags" : [ "InputPorts" ] + }, + "put" : { + "operationId" : "updateInputPort", + "parameters" : [ { + "description" : "The input port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortEntity" + } + } + }, + "description" : "The input port configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ], + "summary" : "Updates an input port", + "tags" : [ "InputPorts" ] + } + }, + "/input-ports/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_2", + "parameters" : [ { + "description" : "The input port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The request to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for an input port", + "tags" : [ "InputPorts" ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_3", + "parameters" : [ { + "description" : "The port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortRunStatusEntity" + } + } + }, + "description" : "The port run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ], + "summary" : "Updates run status of an input-port", + "tags" : [ "InputPorts" ] + } + }, + "/labels/{id}" : { + "delete" : { + "operationId" : "removeLabel", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The label id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes a label", + "tags" : [ "Labels" ] + }, + "get" : { + "operationId" : "getLabel", + "parameters" : [ { + "description" : "The label id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ], + "summary" : "Gets a label", + "tags" : [ "Labels" ] + }, + "put" : { + "operationId" : "updateLabel", + "parameters" : [ { + "description" : "The label id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelEntity" + } + } + }, + "description" : "The label configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ], + "summary" : "Updates a label", + "tags" : [ "Labels" ] + } + }, + "/output-ports/{id}" : { + "delete" : { + "operationId" : "removeOutputPort", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The output port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes an output port", + "tags" : [ "OutputPorts" ] + }, + "get" : { + "operationId" : "getOutputPort", + "parameters" : [ { + "description" : "The output port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ], + "summary" : "Gets an output port", + "tags" : [ "OutputPorts" ] + }, + "put" : { + "operationId" : "updateOutputPort", + "parameters" : [ { + "description" : "The output port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortEntity" + } + } + }, + "description" : "The output port configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ], + "summary" : "Updates an output port", + "tags" : [ "OutputPorts" ] + } + }, + "/output-ports/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_3", + "parameters" : [ { + "description" : "The output port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The request to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for an output port", + "tags" : [ "OutputPorts" ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_4", + "parameters" : [ { + "description" : "The port id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortRunStatusEntity" + } + } + }, + "description" : "The port run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ], + "summary" : "Updates run status of an output-port", + "tags" : [ "OutputPorts" ] + } + }, + "/parameter-contexts" : { + "post" : { + "operationId" : "createParameterContext", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterContextEntity" + } + } + }, + "description" : "The Parameter Context.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + }, { + "Read - for every inherited parameter context" : [ ] + } ], + "summary" : "Create a Parameter Context", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/assets" : { + "get" : { + "operationId" : "getAssets_1", + "parameters" : [ { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AssetsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ], + "summary" : "Lists the assets that belong to the Parameter Context with the given ID.", + "tags" : [ "ParameterContexts" ] + }, + "post" : { + "description" : "This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.", + "operationId" : "createAsset_1", + "parameters" : [ { + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Filename", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "The contents of the asset.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AssetEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "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" : [ ] + }, { + "Read - for every currently inherited parameter context" : [ ] + } ], + "summary" : "Creates a new Asset in the given Parameter Context", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/assets/{assetId}" : { + "delete" : { + "description" : "This endpoint will create a new Asset in the given Parameter Context. The Asset will be created with the given name and the contents of the file that is uploaded. The Asset will be created in the given Parameter Context, and will be available for use by any component that references the Parameter Context.", + "operationId" : "deleteAsset", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Asset", + "in" : "path", + "name" : "assetId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AssetEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "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" : [ ] + }, { + "Read - for every currently inherited parameter context" : [ ] + } ], + "summary" : "Deletes an Asset from the given Parameter Context", + "tags" : [ "ParameterContexts" ] + }, + "get" : { + "operationId" : "getAssetContent_1", + "parameters" : [ { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Asset", + "in" : "path", + "name" : "assetId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "string", + "format" : "byte" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ], + "summary" : "Retrieves the content of the asset with the given id", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "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 action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", + "operationId" : "submitParameterContextUpdate", + "parameters" : [ { + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterContextEntity" + } + } + }, + "description" : "The updated version of the parameter context.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - for every currently inherited parameter context" : [ ] + }, { + "Read - for any new inherited parameter context" : [ ] + } ], + "summary" : "Initiate the Update Request of a Parameter Context", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the ParameterContext", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Update Request with the given ID", + "tags" : [ "ParameterContexts" ] + }, + "get" : { + "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", + "parameters" : [ { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Update Request with the given ID", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "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", + "parameters" : [ { + "description" : "The ID of the ParameterContext", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterContextValidationRequestEntity" + } + } + }, + "description" : "The validation request", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + } ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Validation Request with the given ID", + "tags" : [ "ParameterContexts" ] + }, + "get" : { + "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", + "parameters" : [ { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "contextId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Validation Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Validation Request with the given ID", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-contexts/{id}" : { + "delete" : { + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "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.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The Parameter Context ID.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + } ], + "summary" : "Deletes the Parameter Context with the given ID", + "tags" : [ "ParameterContexts" ] + }, + "get" : { + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "parameters" : [ { + "description" : "The ID of the Parameter Context", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the 'effective' parameter context.", + "in" : "query", + "name" : "includeInheritedParameters", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ], + "summary" : "Returns the Parameter Context with the given ID", + "tags" : [ "ParameterContexts" ] + }, + "put" : { + "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", + "parameters" : [ { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterContextEntity" + } + } + }, + "description" : "The updated Parameter Context", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + }, { + "Read - for every currently inherited parameter context" : [ ] + }, { + "Read - for any new inherited parameter context" : [ ] + } ], + "summary" : "Modifies a Parameter Context", + "tags" : [ "ParameterContexts" ] + } + }, + "/parameter-providers/{id}" : { + "delete" : { + "operationId" : "removeParameterProvider", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Deletes a parameter provider", + "tags" : [ "ParameterProviders" ] + }, + "get" : { + "operationId" : "getParameterProvider", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Gets a parameter provider", + "tags" : [ "ParameterProviders" ] + }, + "put" : { + "operationId" : "updateParameterProvider", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + }, + "description" : "The parameter provider configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates a parameter provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_4", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The clear bulletin request specifying the timestamp from which to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a parameter provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeConfiguration_1", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/config/verification-requests" : { + "post" : { + "description" : "This will initiate the process of verifying a given Parameter Provider configuration. This may be a long-running task. As a result, this endpoint will immediately return a ParameterProviderConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-providers/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/{providerId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest_1", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The parameter provider configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Parameter Provider's configuration", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest_1", + "parameters" : [ { + "description" : "The ID of the Parameter Provider", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "ParameterProviders" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest_1", + "parameters" : [ { + "description" : "The ID of the Parameter Provider", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/descriptors" : { + "get" : { + "operationId" : "getPropertyDescriptor_2", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Gets a parameter provider property descriptor", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/parameters/fetch-requests" : { + "post" : { + "operationId" : "fetchParameters", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderParameterFetchEntity" + } + } + }, + "description" : "The parameter fetch request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Fetches and temporarily caches the parameters for a provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/references" : { + "get" : { + "operationId" : "getParameterProviderReferences", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderReferencingComponentsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Gets all references to a parameter provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/state" : { + "get" : { + "operationId" : "getState_1", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a parameter provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{id}/state/clear-requests" : { + "post" : { + "operationId" : "clearState_2", + "parameters" : [ { + "description" : "The parameter provider id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a parameter provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{providerId}/apply-parameters-requests" : { + "post" : { + "description" : "This will initiate the process of applying fetched parameters to all referencing Parameter Contexts. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterProviderApplyParametersRequestEntity, 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-providers/apply-parameters-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/apply-parameters-requests/{requestId}.", + "operationId" : "submitApplyParameters", + "parameters" : [ { + "description" : "The ID of the Parameter Provider", + "in" : "path", + "name" : "providerId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderParameterApplicationEntity" + } + } + }, + "description" : "The apply parameters request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderApplyParametersRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /parameter-providers/{parameterProviderId}" : [ ] + }, { + "Write - /parameter-providers/{parameterProviderId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ], + "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", + "tags" : [ "ParameterProviders" ] + } + }, + "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Apply Parameters Request with the given ID. After a request is created via a POST to /nifi-api/parameter-providers/apply-parameters-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Apply process has completed. If the request is deleted before the request completes, then the Apply Parameters Request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteApplyParametersRequest", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Parameter Provider", + "in" : "path", + "name" : "providerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Apply Parameters Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderApplyParametersRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Apply Parameters Request with the given ID", + "tags" : [ "ParameterProviders" ] + }, + "get" : { + "description" : "Returns the Apply Parameters Request with the given ID. Once an Apply Parameters Request has been created by performing a POST to /nifi-api/parameter-providers, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getParameterProviderApplyParametersRequest", + "parameters" : [ { + "description" : "The ID of the Parameter Provider", + "in" : "path", + "name" : "providerId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Apply Parameters Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ParameterProviderApplyParametersRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Apply Parameters Request with the given ID", + "tags" : [ "ParameterProviders" ] + } + }, + "/policies" : { + "post" : { + "operationId" : "createAccessPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccessPolicyEntity" + } + } + }, + "description" : "The access policy configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ], + "summary" : "Creates an access policy", + "tags" : [ "Policies" ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The request action.", + "in" : "path", + "name" : "action", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The resource of the policy.", + "in" : "path", + "name" : "resource", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : ".+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ], + "summary" : "Gets an access policy for the specified action and resource", + "tags" : [ "Policies" ] + } + }, + "/policies/{id}" : { + "delete" : { + "operationId" : "removeAccessPolicy", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ], + "summary" : "Deletes an access policy", + "tags" : [ "Policies" ] + }, + "get" : { + "operationId" : "getAccessPolicy", + "parameters" : [ { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ], + "summary" : "Gets an access policy", + "tags" : [ "Policies" ] + }, + "put" : { + "operationId" : "updateAccessPolicy", + "parameters" : [ { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccessPolicyEntity" + } + } + }, + "description" : "The access policy configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ], + "summary" : "Updates a access policy", + "tags" : [ "Policies" ] + } + }, + "/process-groups/replace-requests/{id}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Replace Request with the given ID", + "tags" : [ "ProcessGroups" ] + }, + "get" : { + "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", + "parameters" : [ { + "description" : "The ID of the Replace Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Replace Request with the given ID", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}" : { + "delete" : { + "operationId" : "removeProcessGroup", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + } ], + "summary" : "Deletes a process group", + "tags" : [ "ProcessGroups" ] + }, + "get" : { + "operationId" : "getProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets a process group", + "tags" : [ "ProcessGroups" ] + }, + "put" : { + "operationId" : "updateProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessGroupEntity" + } + } + }, + "description" : "The process group configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates a process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "operationId" : "getConnections", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all connections", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createConnection", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionEntity" + } + } + }, + "description" : "The connection configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ], + "summary" : "Creates a connection", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "operationId" : "createControllerService_1", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ControllerServiceEntity" + } + } + }, + "description" : "The controller service configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new controller service", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/copy" : { + "post" : { + "operationId" : "copy", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CopyRequestEntity" + } + } + }, + "description" : "The request including the components to be copied from the specified Process Group.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CopyResponseEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ], + "summary" : "Generates a copy response for the given copy request", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/download" : { + "get" : { + "operationId" : "exportProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "If referenced services from outside the target group should be included", + "in" : "query", + "name" : "includeReferencedServices", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "If component state should be included in the exported flow definition. Requires all processors to be stopped and all controller services to be disabled.", + "in" : "query", + "name" : "includeComponentState", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid} - Only required when includeComponentState is true" : [ ] + } ], + "summary" : "Gets a process group for download", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/empty-all-connections-requests" : { + "post" : { + "operationId" : "createEmptyAllConnectionsRequest", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DropRequestEntity" + } + } + }, + "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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ], + "summary" : "Creates a request to drop all FlowFiles of all connection queues in this process group.", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { + "delete" : { + "operationId" : "removeDropRequest_1", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The drop request id.", + "in" : "path", + "name" : "drop-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ], + "summary" : "Cancels and/or removes a request to drop all FlowFiles.", + "tags" : [ "ProcessGroups" ] + }, + "get" : { + "operationId" : "getDropAllFlowfilesRequest", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The drop request id.", + "in" : "path", + "name" : "drop-request-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ], + "summary" : "Gets the current status of a drop all FlowFiles request.", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/flow-contents" : { + "put" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessGroupImportEntity" + } + } + }, + "description" : "The process group replace request entity.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "operationId" : "getFunnels", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all funnels", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createFunnel", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/FunnelEntity" + } + } + }, + "description" : "The funnel configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates a funnel", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "operationId" : "getInputPorts", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all input ports", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createInputPort", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortEntity" + } + } + }, + "description" : "The input port configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates an input port", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "operationId" : "getLabels", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all labels", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createLabel", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LabelEntity" + } + } + }, + "description" : "The label configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates a label", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "operationId" : "getLocalModifications", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "operationId" : "getOutputPorts", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all output ports", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createOutputPort", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PortEntity" + } + } + }, + "description" : "The output port configuration.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates an output port", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/paste" : { + "put" : { + "operationId" : "paste", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PasteRequestEntity" + } + } + }, + "description" : "The request including the components to be pasted into the specified Process Group.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PasteResponseEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The 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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Pastes into the specified process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "operationId" : "getProcessGroups", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all process groups", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Handling Strategy controls whether to keep or replace Parameter Contexts", + "in" : "query", + "name" : "parameterContextHandlingStrategy", + "schema" : { + "type" : "string", + "default" : "KEEP_EXISTING", + "enum" : [ "KEEP_EXISTING", "REPLACE" ] + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessGroupEntity" + } + } + }, + "description" : "The process group configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates a process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/process-groups/import" : { + "post" : { + "operationId" : "importProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessGroupUploadEntity" + } + } + }, + "description" : "The Process Group Upload import details" + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Imports a specified process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/process-groups/upload" : { + "post" : { + "operationId" : "uploadProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "The client id." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "default" : false, + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "file" : { + "type" : "object", + "description" : "The flow definition content" + }, + "groupName" : { + "type" : "string", + "description" : "The process group name." + }, + "positionX" : { + "type" : "number", + "format" : "double", + "description" : "The process group X position." + }, + "positionY" : { + "type" : "number", + "format" : "double", + "description" : "The process group Y position." + } + }, + "required" : [ "clientId", "groupName", "positionX", "positionY" ] + } + } + } + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Uploads a versioned flow definition and creates a process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "operationId" : "getProcessors", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether or not to include processors from descendant process groups", + "in" : "query", + "name" : "includeDescendantGroups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all processors", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createProcessor", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessorEntity" + } + } + }, + "description" : "The processor configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Creates a new processor", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "operationId" : "getRemoteProcessGroups", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets all remote process groups", + "tags" : [ "ProcessGroups" ] + }, + "post" : { + "operationId" : "createRemoteProcessGroup", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemoteProcessGroupEntity" + } + } + }, + "description" : "The remote process group configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates a new process group", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/replace-requests" : { + "post" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessGroupImportEntity" + } + } + }, + "description" : "The process group replace request entity", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Initiate the Replace Request of a Process Group with the given ID", + "tags" : [ "ProcessGroups" ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "operationId" : "copySnippet", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CopySnippetRequestEntity" + } + } + }, + "description" : "The copy snippet request.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ], + "summary" : "Copies a snippet and discards it.", + "tags" : [ "ProcessGroups" ] + } + }, + "/processors/run-status-details/queries" : { + "post" : { + "operationId" : "getProcessorRunStatusDetails", + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/RunStatusDetailsRequestEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RunStatusDetailsRequestEntity" + } + } + }, + "description" : "The request for the processors that should be included in the results" + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] + } ], + "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}" : { + "delete" : { + "operationId" : "deleteProcessor", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Deletes a processor", + "tags" : [ "Processors" ] + }, + "get" : { + "operationId" : "getProcessor", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ], + "summary" : "Gets a processor", + "tags" : [ "Processors" ] + }, + "put" : { + "operationId" : "updateProcessor", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessorEntity" + } + } + }, + "description" : "The processor configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/backlog-requests" : { + "post" : { + "description" : "This will initiate the process of determining the backlog for a Processor. This may be a long-running task. As a result, this endpoint will immediately return a BacklogRequestEntity, and the process of determining the backlog will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/backlog-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/backlog-requests/{requestId}.", + "operationId" : "submitProcessorBacklogRequest", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ], + "summary" : "Initiates a request to determine the current backlog for a processor that implements BacklogReportingProcessor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/backlog-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Backlog Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it once the backlog determination has completed. If the request is deleted before it completes, the background determination is cancelled.", + "operationId" : "deleteBacklogRequest", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Backlog Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Backlog Request with the given ID", + "tags" : [ "Processors" ] + }, + "get" : { + "description" : "Returns the Backlog Request with the given ID. Once a Backlog Request has been created by performing a POST to /processors/{processorId}/backlog-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 the backlog once the request is complete.", + "operationId" : "getBacklogRequest", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Backlog Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BacklogRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Backlog Request with the given ID", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_5", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The clear bulletin request specifying the timestamp from which to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeConfiguration_2", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The processor configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/config/verification-requests" : { + "post" : { + "description" : "This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}.", + "operationId" : "submitProcessorVerificationRequest", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The processor configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Processor's configuration", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest_2", + "parameters" : [ { + "description" : "The ID of the Processor", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "Processors" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest_2", + "parameters" : [ { + "description" : "The ID of the Processor", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "operationId" : "getPropertyDescriptor_3", + "parameters" : [ { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property Descriptor requested sensitive status", + "in" : "query", + "name" : "sensitive", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ], + "summary" : "Gets the descriptor for a processor property", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ], + "summary" : "Gets diagnostics information about a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_5", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProcessorRunStatusEntity" + } + } + }, + "description" : "The processor run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/state" : { + "get" : { + "operationId" : "getState_2", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "operationId" : "clearState_3", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a processor", + "tags" : [ "Processors" ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "operationId" : "terminateProcessor", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "tags" : [ "Processors" ] + } + }, + "/provenance" : { + "post" : { + "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", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProvenanceEntity" + } + } + }, + "description" : "The provenance query details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Submits a provenance query", + "tags" : [ "Provenance" ] + } + }, + "/provenance-events/latest/replays" : { + "post" : { + "operationId" : "submitReplayLatestEvent", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReplayLastEventRequestEntity" + } + } + }, + "description" : "The replay request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReplayLastEventResponseEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Replays content from a provenance event", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance-events/latest/{componentId}" : { + "get" : { + "operationId" : "getLatestProvenanceEvents", + "parameters" : [ { + "description" : "The ID of the component to retrieve the latest Provenance Events for.", + "in" : "path", + "name" : "componentId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The number of events to limit the response to. Defaults to 10.", + "in" : "query", + "name" : "limit", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LatestProvenanceEventsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Retrieves the latest cached Provenance Events for the specified component", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance-events/replays" : { + "post" : { + "operationId" : "submitReplay", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SubmitReplayRequestEntity" + } + } + }, + "description" : "The replay request.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Replays content from a provenance event", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "operationId" : "getProvenanceEvent", + "parameters" : [ { + "description" : "The id of the node where this event exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The provenance event id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets a provenance event", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "operationId" : "getInputContent", + "parameters" : [ { + "description" : "Range of bytes requested", + "in" : "header", + "name" : "Range", + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the node where the content exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The provenance event id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingOutput" + } + } + } + }, + "206" : { + "description" : "Partial Content with range of bytes requested" + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + }, + "416" : { + "description" : "Requested Range Not Satisfiable based on bytes requested" + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets the input content for a provenance event", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "operationId" : "getOutputContent", + "parameters" : [ { + "description" : "Range of bytes requested", + "in" : "header", + "name" : "Range", + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the node where the content exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The provenance event id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingOutput" + } + } + } + }, + "206" : { + "description" : "Partial Content with range of bytes requested" + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + }, + "416" : { + "description" : "Requested Range Not Satisfiable based on bytes requested" + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets the output content for a provenance event", + "tags" : [ "ProvenanceEvents" ] + } + }, + "/provenance/lineage" : { + "post" : { + "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", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LineageEntity" + } + } + }, + "description" : "The lineage query details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Submits a lineage query", + "tags" : [ "Provenance" ] + } + }, + "/provenance/lineage/{id}" : { + "delete" : { + "operationId" : "deleteLineage", + "parameters" : [ { + "description" : "The id of the node where this query exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the lineage query.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ], + "summary" : "Deletes a lineage query", + "tags" : [ "Provenance" ] + }, + "get" : { + "operationId" : "getLineage", + "parameters" : [ { + "description" : "The id of the node where this query exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the lineage query.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets a lineage query", + "tags" : [ "Provenance" ] + } + }, + "/provenance/search-options" : { + "get" : { + "operationId" : "getSearchOptions", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ], + "summary" : "Gets the searchable attributes for provenance events", + "tags" : [ "Provenance" ] + } + }, + "/provenance/{id}" : { + "delete" : { + "operationId" : "deleteProvenance", + "parameters" : [ { + "description" : "The id of the node where this query exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "The id of the provenance query.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ], + "summary" : "Deletes a provenance query", + "tags" : [ "Provenance" ] + }, + "get" : { + "operationId" : "getProvenance", + "parameters" : [ { + "description" : "The id of the node where this query exists if clustered.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "in" : "query", + "name" : "summarize", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "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.", + "in" : "query", + "name" : "incrementalResults", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "description" : "The id of the provenance query.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ], + "summary" : "Gets a provenance query", + "tags" : [ "Provenance" ] + } + }, + "/remote-process-groups/process-group/{id}/run-status" : { + "put" : { + "operationId" : "updateRemoteProcessGroupRunStatuses", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemotePortRunStatusEntity" + } + } + }, + "description" : "The remote process groups run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates run status of all remote process groups in a process group (recursively)", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}" : { + "delete" : { + "operationId" : "removeRemoteProcessGroup", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes a remote process group", + "tags" : [ "RemoteProcessGroups" ] + }, + "get" : { + "operationId" : "getRemoteProcessGroup", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets a remote process group", + "tags" : [ "RemoteProcessGroups" ] + }, + "put" : { + "operationId" : "updateRemoteProcessGroup", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemoteProcessGroupEntity" + } + } + }, + "description" : "The remote process group configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates a remote process group", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_6", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The clear bulletin request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a remote process group", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group port id.", + "in" : "path", + "name" : "port-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemoteProcessGroupPortEntity" + } + } + }, + "description" : "The remote process group port configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates a remote port", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group port id.", + "in" : "path", + "name" : "port-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemotePortRunStatusEntity" + } + } + }, + "description" : "The remote process group port run status details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a remote input port", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group port id.", + "in" : "path", + "name" : "port-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemoteProcessGroupPortEntity" + } + } + }, + "description" : "The remote process group port configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates a remote port", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The remote process group port id.", + "in" : "path", + "name" : "port-id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemotePortRunStatusEntity" + } + } + }, + "description" : "The remote process group port run status details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a remote output port", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "operationId" : "updateRemoteProcessGroupRunStatus", + "parameters" : [ { + "description" : "The remote process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RemotePortRunStatusEntity" + } + } + }, + "description" : "The remote process group run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a remote process group", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "operationId" : "getState_3", + "parameters" : [ { + "description" : "The processor id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a RemoteProcessGroup", + "tags" : [ "RemoteProcessGroups" ] + } + }, + "/reporting-tasks/{id}" : { + "delete" : { + "operationId" : "removeReportingTask", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Deletes a reporting task", + "tags" : [ "ReportingTasks" ] + }, + "get" : { + "operationId" : "getReportingTask", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Gets a reporting task", + "tags" : [ "ReportingTasks" ] + }, + "put" : { + "operationId" : "updateReportingTask", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReportingTaskEntity" + } + } + }, + "description" : "The reporting task configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Updates a reporting task", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/bulletins/clear-requests" : { + "post" : { + "operationId" : "clearBulletins_7", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsRequestEntity" + } + } + }, + "description" : "The clear bulletin request specifying the timestamp from which to clear bulletins.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClearBulletinsResultEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Clears bulletins for a reporting task", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/config/analysis" : { + "post" : { + "operationId" : "analyzeConfiguration_3", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + }, + "description" : "The configuration analysis request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/config/verification-requests" : { + "post" : { + "description" : "This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest_2", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + }, + "description" : "The reporting task configuration verification request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ], + "summary" : "Performs verification of the Reporting Task's configuration", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { + "delete" : { + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest_3", + "parameters" : [ { + "description" : "The ID of the Reporting Task", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Verification Request with the given ID", + "tags" : [ "ReportingTasks" ] + }, + "get" : { + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest_3", + "parameters" : [ { + "description" : "The ID of the Reporting Task", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The ID of the Verification Request", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyConfigRequestEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Verification Request with the given ID", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "operationId" : "getPropertyDescriptor_4", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The property name.", + "in" : "query", + "name" : "propertyName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Property Descriptor requested sensitive status", + "in" : "query", + "name" : "sensitive", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Gets a reporting task property descriptor", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "operationId" : "updateRunStatus_6", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ReportingTaskRunStatusEntity" + } + } + }, + "description" : "The reporting task run status.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Updates run status of a reporting task", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "operationId" : "getState_4", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Gets the state for a reporting task", + "tags" : [ "ReportingTasks" ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "operationId" : "clearState_4", + "parameters" : [ { + "description" : "The reporting task id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + }, + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ComponentStateEntity" + } + } + }, + "description" : "Optional component state to perform a selective key removal. If omitted, clears all state." + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ], + "summary" : "Clears the state for a reporting task", + "tags" : [ "ReportingTasks" ] + } + }, + "/resources" : { + "get" : { + "operationId" : "getResources", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResourcesEntity" + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ], + "summary" : "Gets the available resources that support access/authorization policies", + "tags" : [ "Resources" ] + } + }, + "/site-to-site" : { + "get" : { + "operationId" : "getSiteToSiteDetails", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "tags" : [ "SiteToSite" ] + } + }, + "/site-to-site/peers" : { + "get" : { + "operationId" : "getPeers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PeersEntity" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ], + "summary" : "Returns the available Peers and its status of this NiFi", + "tags" : [ "SiteToSite" ] + } + }, + "/snippets" : { + "post" : { + "operationId" : "createSnippet", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SnippetEntity" + } + } + }, + "description" : "The snippet configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "tags" : [ "Snippets" ] + } + }, + "/snippets/{id}" : { + "delete" : { + "operationId" : "deleteSnippet", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The snippet id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "tags" : [ "Snippets" ] + }, + "put" : { + "operationId" : "updateSnippet", + "parameters" : [ { + "description" : "The snippet id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SnippetEntity" + } + } + }, + "description" : "The snippet configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "tags" : [ "Snippets" ] + } + }, + "/system-diagnostics" : { + "get" : { + "operationId" : "getSystemDiagnostics", + "parameters" : [ { + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "in" : "query", + "name" : "nodewise", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "BASIC or VERBOSE verbosity details. Optional, defaults to BASIC", + "in" : "query", + "name" : "diagnosticLevel", + "schema" : { + "type" : "string", + "default" : "BASIC", + "enum" : [ "BASIC", "VERBOSE" ] + } + }, { + "description" : "The id of the node where to get the status.", + "in" : "query", + "name" : "clusterNodeId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemDiagnosticsEntity" + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "tags" : [ "SystemDiagnostics" ] + } + }, + "/system-diagnostics/jmx-metrics" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getJmxMetrics", + "parameters" : [ { + "description" : "Regular Expression Pattern to be applied against the ObjectName", + "in" : "query", + "name" : "beanNameFilter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JmxMetricsResultsEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ], + "summary" : "Retrieve available JMX metrics", + "tags" : [ "SystemDiagnostics" ] + } + }, + "/tenants/search-results" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "parameters" : [ { + "description" : "Identity to search for.", + "in" : "query", + "name" : "q", + "required" : true, + "schema" : { + "type" : "string", + "default" : "" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ], + "summary" : "Searches for a tenant with the specified identity", + "tags" : [ "Tenants" ] + } + }, + "/tenants/user-groups" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ], + "summary" : "Gets all user groups", + "tags" : [ "Tenants" ] + }, + "post" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserGroupEntity" + } + } + }, + "description" : "The user group configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Creates a user group", + "tags" : [ "Tenants" ] + } + }, + "/tenants/user-groups/{id}" : { + "delete" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Deletes a user group", + "tags" : [ "Tenants" ] + }, + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "parameters" : [ { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ], + "summary" : "Gets a user group", + "tags" : [ "Tenants" ] + }, + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "parameters" : [ { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserGroupEntity" + } + } + }, + "description" : "The user group configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Updates a user group", + "tags" : [ "Tenants" ] + } + }, + "/tenants/users" : { + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ], + "summary" : "Gets all users", + "tags" : [ "Tenants" ] + }, + "post" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserEntity" + } + } + }, + "description" : "The user configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Creates a user", + "tags" : [ "Tenants" ] + } + }, + "/tenants/users/{id}" : { + "delete" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "parameters" : [ { + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Deletes a user", + "tags" : [ "Tenants" ] + }, + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "parameters" : [ { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ], + "summary" : "Gets a user", + "tags" : [ "Tenants" ] + }, + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "parameters" : [ { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserEntity" + } + } + }, + "description" : "The user configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ], + "summary" : "Updates a user", + "tags" : [ "Tenants" ] + } + }, + "/versions/active-requests" : { + "post" : { + "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", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateActiveRequestEntity" + } + } + }, + "description" : "The versioned flow details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "text/plain" : { + "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." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Create a version control request", + "tags" : [ "Versions" ] + } + }, + "/versions/active-requests/{id}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The request ID.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the version control request with the given ID", + "tags" : [ "Versions" ] + }, + "put" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "parameters" : [ { + "description" : "The request ID.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionControlComponentMappingEntity" + } + } + }, + "description" : "The version control component mapping.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ], + "summary" : "Updates the request with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/process-groups/{id}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "in" : "query", + "name" : "version", + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "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.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Stops version controlling the Process Group with the given ID", + "tags" : [ "Versions" ] + }, + "get" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets the Version Control information for a process group", + "tags" : [ "Versions" ] + }, + "post" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StartVersionControlRequestEntity" + } + } + }, + "description" : "The versioned flow details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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}" : [ ] + } ], + "summary" : "Save the Process Group with the given ID", + "tags" : [ "Versions" ] + }, + "put" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshotEntity" + } + } + }, + "description" : "The controller service configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Update the version of a Process Group with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/process-groups/{id}/branches" : { + "post" : { + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createFlowBranch", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateFlowBranchRequestEntity" + } + } + }, + "description" : "The branch creation request.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Creates a new branch for a version controlled Process Group", + "tags" : [ "Versions" ] + } + }, + "/versions/process-groups/{id}/download" : { + "get" : { + "operationId" : "exportFlowVersion", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "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." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets the latest version of a Process Group for download", + "tags" : [ "Versions" ] + } + }, + "/versions/process-groups/{id}/rebase" : { + "put" : { + "description" : "This endpoint is used internally to apply a rebase to a Process Group on each node of a cluster. It synchronizes the flow to the supplied merged snapshot and then resets the Version Control Information to the clean target version so that the preserved local changes are detected as local modifications. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "applyRebasedFlowVersion", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshotEntity" + } + } + }, + "description" : "The rebased versioned flow snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Applies a rebased flow to a Process Group with the given ID on this node", + "tags" : [ "Versions" ] + } + }, + "/versions/rebase-analysis/process-groups/{id}" : { + "get" : { + "description" : "For a Process Group that is under Version Control, this will perform a rebase analysis by comparing local modifications against upstream changes between the current version and the specified target version. The analysis determines whether a rebase is allowed or if there are conflicts.", + "operationId" : "getRebaseAnalysis", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The target version to rebase to.", + "in" : "query", + "name" : "targetVersion", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RebaseAnalysisEntity" + } + } + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ], + "summary" : "Gets a Rebase Analysis for a Process Group", + "tags" : [ "Versions" ] + } + }, + "/versions/rebase-requests/process-groups/{id}" : { + "post" : { + "description" : "For a Process Group that is already under Version Control, this will initiate the action of rebasing the flow to a different version while preserving compatible local changes. 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 rebasing 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/rebase-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/rebase-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "initiateRebase", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RebaseRequestEntity" + } + } + }, + "description" : "The rebase request details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Initiate a Rebase Request for a Process Group with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/rebase-requests/{id}" : { + "delete" : { + "description" : "Deletes the Rebase Request with the given ID. After a request is created via a POST to /versions/rebase-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Rebase process has completed. If the request is deleted before the request completes, then the Rebase 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" : "deleteRebaseRequest", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Rebase Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Rebase Request with the given ID", + "tags" : [ "Versions" ] + }, + "get" : { + "description" : "Returns the Rebase Request with the given ID. Once a Rebase Request has been created by performing a POST to /versions/rebase-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" : "getRebaseRequest", + "parameters" : [ { + "description" : "The ID of the Rebase Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Rebase Request with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionControlInformationEntity" + } + } + }, + "description" : "The Version Control Information to revert to.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/revert-requests/{id}" : { + "delete" : { + "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", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Revert Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Revert Request with the given ID", + "tags" : [ "Versions" ] + }, + "get" : { + "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", + "parameters" : [ { + "description" : "The ID of the Revert Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Revert Request with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "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", + "parameters" : [ { + "description" : "The process group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionControlInformationEntity" + } + } + }, + "description" : "The controller service configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "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" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "tags" : [ "Versions" ] + } + }, + "/versions/update-requests/{id}" : { + "delete" : { + "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_1", + "parameters" : [ { + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "in" : "query", + "name" : "disconnectedNodeAcknowledged", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ], + "summary" : "Deletes the Update Request with the given ID", + "tags" : [ "Versions" ] + }, + "get" : { + "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", + "parameters" : [ { + "description" : "The ID of the Update Request", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ], + "summary" : "Returns the Update Request with the given ID", + "tags" : [ "Versions" ] + } + } + }, + "components" : { + "schemas" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/components/schemas/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "$ref" : "#/components/schemas/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + }, + "uniqueItems" : true + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + }, + "uniqueItems" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "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.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/AccessPolicyDTO" + }, + "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." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "readOnly" : true, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "$ref" : "#/components/schemas/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "description" : "The access policies this user belongs to.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/AccessPolicySummaryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "readOnly" : true, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "actionDetails" : { + "$ref" : "#/components/schemas/ActionDetailsDTO" + }, + "componentDetails" : { + "$ref" : "#/components/schemas/ComponentDetailsDTO" + }, + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "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." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + } + } + }, + "ActionDetailsDTO" : { + "type" : "object", + "description" : "The details of the action." + }, + "ActionEntity" : { + "type" : "object", + "description" : "The actions.", + "properties" : { + "action" : { + "$ref" : "#/components/schemas/ActionDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "id" : { + "type" : "integer", + "format" : "int32" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AdditionalDetailsEntity" : { + "type" : "object", + "properties" : { + "additionalDetails" : { + "type" : "string" + } + }, + "xml" : { + "name" : "additionalDetailsEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP" ] + }, + "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." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string", + "description" : "The validation errors for the component." + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "description" : "The set of all components in the flow that are referencing this Parameter", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/AffectedComponentDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "processGroup" : { + "$ref" : "#/components/schemas/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + }, + "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." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "properties" : { + "allowableValue" : { + "$ref" : "#/components/schemas/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "AssetDTO" : { + "type" : "object", + "description" : "The Asset.", + "properties" : { + "digest" : { + "type" : "string", + "description" : "The digest of the asset, will be null if the asset content is missing." + }, + "id" : { + "type" : "string", + "description" : "The identifier of the asset." + }, + "missingContent" : { + "type" : "boolean", + "description" : "Indicates if the content of the asset is missing." + }, + "name" : { + "type" : "string", + "description" : "The name of the asset." + } + }, + "readOnly" : true + }, + "AssetEntity" : { + "type" : "object", + "description" : "The asset entities", + "properties" : { + "asset" : { + "$ref" : "#/components/schemas/AssetDTO" + } + }, + "xml" : { + "name" : "assetEntity" + } + }, + "AssetReferenceDTO" : { + "type" : "object", + "description" : "A list of identifiers of the assets that are referenced by the parameter", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the referenced asset." + }, + "missingContent" : { + "type" : "boolean", + "description" : "Indicates if the content of the asset is missing.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the referenced asset.", + "readOnly" : true + } + } + }, + "AssetsEntity" : { + "type" : "object", + "properties" : { + "assets" : { + "type" : "array", + "description" : "The asset entities", + "items" : { + "$ref" : "#/components/schemas/AssetEntity" + } + } + }, + "xml" : { + "name" : "assetEntity" + } + }, + "Attribute" : { + "type" : "object", + "description" : "The FlowFile attributes this processor writes/updates", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the attribute" + }, + "name" : { + "type" : "string", + "description" : "The name of the attribute" + } + } + }, + "AttributeDTO" : { + "type" : "object", + "description" : "The attributes of the flowfile for the event.", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + } + } + }, + "AuthenticationConfigurationDTO" : { + "type" : "object", + "properties" : { + "externalLoginRequired" : { + "type" : "boolean", + "description" : "Whether the system requires login through an external Identity Provider", + "readOnly" : true + }, + "loginSupported" : { + "type" : "boolean", + "description" : "Whether the system is configured to support login operations", + "readOnly" : true + }, + "loginUri" : { + "type" : "string", + "description" : "Location for initiating login processing", + "nullable" : true, + "readOnly" : true + }, + "logoutUri" : { + "type" : "string", + "description" : "Location for initiating logout processing", + "nullable" : true, + "readOnly" : true + } + } + }, + "AuthenticationConfigurationEntity" : { + "type" : "object", + "properties" : { + "authenticationConfiguration" : { + "$ref" : "#/components/schemas/AuthenticationConfigurationDTO" + } + }, + "xml" : { + "name" : "authenticationConfigurationEntity" + } + }, + "BacklogDTO" : { + "type" : "object", + "description" : "The backlog reported by the component, populated once the request has completed successfully.", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes remaining on the source, if the component can determine it." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of FlowFiles remaining on the source, if the component can determine it." + }, + "formattedByteCount" : { + "type" : "string", + "description" : "The byte count formatted for display in human-readable units (for example, '4.89 GB'). Populated whenever byteCount is populated." + }, + "formattedFlowFileCount" : { + "type" : "string", + "description" : "The FlowFile count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever flowFileCount is populated." + }, + "formattedLastCaughtUp" : { + "type" : "string", + "description" : "Human-readable description of how long ago the component was last caught up, for example '5 mins ago', 'in 2 hours', or 'now'. Populated whenever lastCaughtUp is populated." + }, + "formattedRecordCount" : { + "type" : "string", + "description" : "The record count formatted for display with locale-appropriate grouping (for example, '1,025'). Populated whenever recordCount is populated." + }, + "lastCaughtUp" : { + "type" : "string", + "description" : "The most recent moment the component observed itself as fully caught up with the source, formatted as an ISO-8601 UTC timestamp." + }, + "precision" : { + "type" : "string", + "description" : "The precision of the numeric dimensions of this backlog.", + "enum" : [ "EXACT", "AT_LEAST" ] + }, + "recordCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of records remaining on the source, if the component can determine it." + } + }, + "readOnly" : true + }, + "BacklogRequestDTO" : { + "type" : "object", + "description" : "The request", + "properties" : { + "backlog" : { + "$ref" : "#/components/schemas/BacklogDTO" + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the Processor or Connector whose backlog is being determined" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "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 + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/BacklogUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "BacklogRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "$ref" : "#/components/schemas/BacklogRequestDTO" + } + }, + "xml" : { + "name" : "backlogRequestEntity" + } + }, + "BacklogUpdateStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "footerText" : { + "type" : "string", + "description" : "The footer text." + }, + "headerText" : { + "type" : "string", + "description" : "The header text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/components/schemas/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "description" : "The batch settings for data transmission.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of FlowFiles to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + } + } + }, + "BatchSize" : { + "type" : "object", + "description" : "The batch settings for data transmission.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of FlowFiles to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + } + } + }, + "BuildInfo" : { + "type" : "object", + "description" : "The build metadata for this component", + "properties" : { + "compiler" : { + "type" : "string", + "description" : "The compiler used for the build" + }, + "compilerFlags" : { + "type" : "string", + "description" : "The compiler flags used for the build." + }, + "revision" : { + "type" : "string", + "description" : "The SCM revision id of the source code used for this build." + }, + "targetArch" : { + "type" : "string", + "description" : "The target architecture of the built component." + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp (milliseconds since Epoch) of the build." + }, + "version" : { + "type" : "string", + "description" : "The version number of the built component." + } + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/components/schemas/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinBoardPatternParameter" : { + "type" : "object", + "properties" : { + "pattern" : { + "type" : "object" + }, + "rawPattern" : { + "type" : "string" + } + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "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" + }, + "stackTrace" : { + "type" : "string", + "description" : "The stack trace associated with the bulletin, if any." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "timestampIso" : { + "type" : "string", + "description" : "When this bulletin was generated in ISO format with full date and milliseconds." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "description" : "The bulletins for this component.", + "properties" : { + "bulletin" : { + "$ref" : "#/components/schemas/BulletinDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "groupId" : { + "type" : "string" + }, + "id" : { + "type" : "integer", + "format" : "int64" + }, + "nodeAddress" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "timestampIso" : { + "type" : "string", + "description" : "When this bulletin was generated in ISO format with full date and milliseconds." + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "description" : "The details of the artifact that bundled this parameter provider.", + "properties" : { + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "properties" : { + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClearBulletinsForGroupRequestEntity" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Optional component IDs for which to clear bulletins. If not specified, all authorized descendant components will be used.", + "items" : { + "type" : "string", + "description" : "Optional component IDs for which to clear bulletins. If not specified, all authorized descendant components will be used." + }, + "uniqueItems" : true + }, + "fromTimestamp" : { + "type" : "string", + "description" : "The timestamp from which to clear bulletins (inclusive). This field is required." + }, + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + } + }, + "required" : [ "fromTimestamp" ], + "xml" : { + "name" : "clearBulletinsForGroupRequestEntity" + } + }, + "ClearBulletinsForGroupResultsEntity" : { + "type" : "object", + "properties" : { + "bulletinsCleared" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of bulletins that were cleared." + } + }, + "xml" : { + "name" : "clearBulletinsForGroupResultsEntity" + } + }, + "ClearBulletinsRequestEntity" : { + "type" : "object", + "properties" : { + "fromTimestamp" : { + "type" : "string", + "description" : "The timestamp from which to clear bulletins (inclusive). This field is required." + } + }, + "required" : [ "fromTimestamp" ], + "xml" : { + "name" : "clearBulletinsRequestEntity" + } + }, + "ClearBulletinsResultEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The current bulletins for the component after clearing.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "bulletinsCleared" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of bulletins that were cleared." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component for which bulletins were cleared." + } + }, + "xml" : { + "name" : "clearBulletinsResultEntity" + } + }, + "ClientIdParameter" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string" + } + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + }, + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/components/schemas/NodeDTO" + } + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/components/schemas/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + } + } + }, + "ClusterSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/components/schemas/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ComponentDetailsDTO" : { + "type" : "object", + "description" : "The details of the source component." + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "description" : "The set of upstream changes between the current version and the target version in the flow registry", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/components/schemas/DifferenceDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyHistoryDTO" + }, + "description" : "The history for the properties of the component." + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/components/schemas/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentManifest" : { + "type" : "object", + "description" : "The full specification of the bundle contents", + "properties" : { + "apis" : { + "type" : "array", + "description" : "Public interfaces defined in this bundle", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "connectors" : { + "type" : "array", + "description" : "Connectors provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/ConnectorDefinition" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "Controller Services provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceDefinition" + } + }, + "flowAnalysisRules" : { + "type" : "array", + "description" : "Flow Analysis Rules provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleDefinition" + } + }, + "flowRegistryClients" : { + "type" : "array", + "description" : "Flow Registry Clients provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/FlowRegistryClientDefinition" + } + }, + "parameterProviders" : { + "type" : "array", + "description" : "Parameter Providers provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/ParameterProviderDefinition" + } + }, + "processors" : { + "type" : "array", + "description" : "Processors provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/ProcessorDefinition" + } + }, + "reportingTasks" : { + "type" : "array", + "description" : "Reporting Tasks provided in this bundle", + "items" : { + "$ref" : "#/components/schemas/ReportingTaskDefinition" + } + } + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "description" : "Component this policy references if applicable.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ComponentReferenceDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "description" : "Permissions for specific component restrictions.", + "properties" : { + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "requiredPermission" : { + "$ref" : "#/components/schemas/RequiredPermissionDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "description" : "The parameters that matched the search.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string", + "description" : "What matched the search from the component." + } + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "parentGroup" : { + "$ref" : "#/components/schemas/SearchResultGroupDTO" + }, + "versionedGroup" : { + "$ref" : "#/components/schemas/SearchResultGroupDTO" + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "description" : "The component state.", + "properties" : { + "clusterState" : { + "$ref" : "#/components/schemas/StateMapDTO" + }, + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "dropStateKeySupported" : { + "type" : "boolean", + "description" : "Whether dropping state by key is supported for this component. Defaults to false when not specified by the component." + }, + "localState" : { + "$ref" : "#/components/schemas/StateMapDTO" + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "$ref" : "#/components/schemas/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "STATELESS_GROUP" ] + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed" + } + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "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." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string", + "description" : "The validation errors for the component." + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ComponentValidationResultDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/components/schemas/ComponentValidationResultEntity" + } + } + }, + "readOnly" : true, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConfigVerificationResultDTO" : { + "type" : "object", + "description" : "The Results of the verification", + "properties" : { + "explanation" : { + "type" : "string", + "description" : "An explanation of why the step was or was not successful" + }, + "outcome" : { + "type" : "string", + "description" : "The outcome of the verification", + "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] + }, + "subject" : { + "type" : "string", + "description" : "The subject of the verification step" + }, + "verificationStepName" : { + "type" : "string", + "description" : "The name of the verification step" + } + }, + "readOnly" : true + }, + "ConfigurationAnalysisDTO" : { + "type" : "object", + "description" : "The configuration analysis", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The configured properties for the component" + }, + "description" : "The configured properties for the component" + }, + "referencedAttributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The attributes that are referenced by the properties, mapped to recently used values" + }, + "description" : "The attributes that are referenced by the properties, mapped to recently used values" + }, + "supportsVerification" : { + "type" : "boolean", + "description" : "Whether or not the component supports verification" + } + } + }, + "ConfigurationAnalysisEntity" : { + "type" : "object", + "properties" : { + "configurationAnalysis" : { + "$ref" : "#/components/schemas/ConfigurationAnalysisDTO" + } + }, + "xml" : { + "name" : "configurationAnalysis" + } + }, + "ConfigurationStep" : { + "type" : "object", + "description" : "The configuration steps for this connector", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the configuration step" + }, + "documented" : { + "type" : "boolean", + "description" : "Whether this configuration step has additional documentation" + }, + "name" : { + "type" : "string", + "description" : "The name of the configuration step" + }, + "propertyGroups" : { + "type" : "array", + "description" : "The property groups in this configuration step", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyGroup" + } + }, + "stepDependencies" : { + "type" : "array", + "description" : "The dependencies that this step has on other steps", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStepDependency" + } + } + } + }, + "ConfigurationStepConfigurationDTO" : { + "type" : "object", + "description" : "The list of configuration step configurations for this Connector.", + "properties" : { + "configurationStepDescription" : { + "type" : "string", + "description" : "The description of the configuration step." + }, + "configurationStepName" : { + "type" : "string", + "description" : "The name of the configuration step." + }, + "dependencies" : { + "type" : "array", + "description" : "The dependencies that this configuration step has on other configuration steps' properties.", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStepDependencyDTO" + }, + "uniqueItems" : true + }, + "documented" : { + "type" : "boolean", + "description" : "Whether extended documentation is available for this configuration step." + }, + "propertyGroupConfigurations" : { + "type" : "array", + "description" : "The list of property group configurations for this configuration step.", + "items" : { + "$ref" : "#/components/schemas/PropertyGroupConfigurationDTO" + } + } + } + }, + "ConfigurationStepDependency" : { + "type" : "object", + "description" : "The dependencies that this step has on other steps", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that enable this step", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that enable this step" + } + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property within the step that this step depends on" + }, + "stepName" : { + "type" : "string", + "description" : "The name of the step that this step depends on" + } + } + }, + "ConfigurationStepDependencyDTO" : { + "type" : "object", + "description" : "The dependencies that this configuration step has on other configuration steps' properties.", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that satisfy this dependency. If null, any non-null value satisfies the dependency.", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that satisfy this dependency. If null, any non-null value satisfies the dependency." + }, + "uniqueItems" : true + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property within the dependent step that must have a value." + }, + "stepName" : { + "type" : "string", + "description" : "The name of the configuration step that this step depends on." + } + } + }, + "ConfigurationStepEntity" : { + "type" : "object", + "properties" : { + "configurationStep" : { + "$ref" : "#/components/schemas/ConfigurationStepConfigurationDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentConnectorId" : { + "type" : "string", + "description" : "The id of the parent connector." + }, + "parentConnectorRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "configurationStepEntity" + } + }, + "ConfigurationStepNamesEntity" : { + "type" : "object", + "properties" : { + "configurationStepNames" : { + "type" : "array", + "description" : "The list of configuration step names for a connector.", + "items" : { + "type" : "string", + "description" : "The list of configuration step names for a connector." + } + } + }, + "xml" : { + "name" : "configurationStepNamesEntity" + } + }, + "ConnectableComponent" : { + "type" : "object", + "description" : "The destination of the connection.", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The name 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" ] + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "description" : "The destination of the connection.", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "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." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + }, + "required" : [ "groupId", "id", "type" ] + }, + "ConnectionDTO" : { + "type" : "object", + "description" : "The connections in this flow snippet.", + "properties" : { + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "items" : { + "type" : "string", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true + }, + "readOnly" : true, + "uniqueItems" : true + }, + "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." + }, + "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." + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/components/schemas/PositionDTO" + } + }, + "destination" : { + "$ref" : "#/components/schemas/ConnectableDTO" + }, + "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." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster. Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details." + }, + "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" + }, + "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. Possible returned values: LOAD_BALANCE_NOT_CONFIGURED, LOAD_BALANCE_INACTIVE, LOAD_BALANCE_ACTIVE. See LoadBalanceStatus.class for more details.", + "readOnly" : true + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string", + "description" : "The comparators used to prioritize the queue." + } + }, + "retriedRelationships" : { + "type" : "array", + "description" : "The relationships from the source of the connection that are configured to be retried.", + "items" : { + "type" : "string", + "description" : "The relationships from the source of the connection that are configured to be retried.", + "readOnly" : true + }, + "readOnly" : true, + "uniqueItems" : true + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "items" : { + "type" : "string", + "description" : "The selected relationship that comprise the connection." + }, + "uniqueItems" : true + }, + "source" : { + "$ref" : "#/components/schemas/ConnectableDTO" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "description" : "The connections in this flow.", + "properties" : { + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/components/schemas/PositionDTO" + } + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ConnectionDTO" + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier 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" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier 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" ] + }, + "status" : { + "$ref" : "#/components/schemas/ConnectionStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "required" : [ "destinationType", "sourceType" ], + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ConnectionStatisticsSnapshotDTO" + }, + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/components/schemas/NodeConnectionStatisticsSnapshotDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "connectionStatistics" : { + "$ref" : "#/components/schemas/ConnectionStatisticsDTO" + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "description" : "The connection status snapshot from the node.", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "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." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "description" : "The status of the connection.", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ConnectionStatusSnapshotDTO" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/components/schemas/NodeConnectionStatusSnapshotDTO" + } + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "connectionStatus" : { + "$ref" : "#/components/schemas/ConnectionStatusDTO" + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "description" : "Predictions, if available, for this connection (null if not available)", + "properties" : { + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "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." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued FlowFiles size and backpressure threshold if configured." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued FlowFiles count and backpressure threshold if configured." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into 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." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in 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." + }, + "flowFileAvailability" : { + "type" : "string", + "description" : "The availability of FlowFiles in this connection" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "The load balance status of the connection", + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_ACTIVE", "LOAD_BALANCE_INACTIVE" ] + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the connection in the last 5 minutes, pretty printed." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued FlowFiles size and backpressure threshold if configured." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued FlowFiles count and backpressure threshold if configured." + }, + "predictions" : { + "$ref" : "#/components/schemas/ConnectionStatusPredictionsSnapshotDTO" + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued FlowFiles formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of FlowFiles that are queued, pretty printed." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of FlowFiles that are queued formatted." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "description" : "The status of all connections in the process group.", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "connectionStatusSnapshot" : { + "$ref" : "#/components/schemas/ConnectionStatusSnapshotDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the connection." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConnectionEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ConnectorActionDTO" : { + "type" : "object", + "description" : "The available actions that can be performed on this Connector.", + "properties" : { + "allowed" : { + "type" : "boolean", + "description" : "Whether this action is currently allowed to be performed, based on the state of the Connector. Note that a value of 'true' does not imply that the user has permission to perform the action." + }, + "description" : { + "type" : "string", + "description" : "A description of what this action does." + }, + "name" : { + "type" : "string", + "description" : "The name of the action." + }, + "reasonNotAllowed" : { + "type" : "string", + "description" : "The reason why this action is not allowed, or null if the action is allowed." + } + } + }, + "ConnectorConfigurationDTO" : { + "type" : "object", + "description" : "The working configuration of the Connector.", + "properties" : { + "configurationStepConfigurations" : { + "type" : "array", + "description" : "The list of configuration step configurations for this Connector.", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStepConfigurationDTO" + } + } + } + }, + "ConnectorDTO" : { + "type" : "object", + "description" : "The Connector DTO", + "properties" : { + "activeConfiguration" : { + "$ref" : "#/components/schemas/ConnectorConfigurationDTO" + }, + "availableActions" : { + "type" : "array", + "description" : "The available actions that can be performed on this Connector.", + "items" : { + "$ref" : "#/components/schemas/ConnectorActionDTO" + } + }, + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "configurationUrl" : { + "type" : "string", + "description" : "The URL for this connector's configuration/wizard custom UI, if applicable." + }, + "detailsUrl" : { + "type" : "string", + "description" : "The URL for this connector's details custom UI, if applicable." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the extension for this connector is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "managedProcessGroupId" : { + "type" : "string", + "description" : "The identifier of the root Process Group managed by this Connector." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether multiple versions of this connector are available." + }, + "name" : { + "type" : "string", + "description" : "The name of the Connector." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the Connector.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the Connector." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the connector.", + "items" : { + "type" : "string", + "description" : "The validation errors for the connector." + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Connector is valid, invalid, or still in the process of validating" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "workingConfiguration" : { + "$ref" : "#/components/schemas/ConnectorConfigurationDTO" + } + } + }, + "ConnectorDefinition" : { + "type" : "object", + "description" : "Connectors provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "configurationSteps" : { + "type" : "array", + "description" : "The configuration steps for this connector", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStep" + } + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "ConnectorEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ConnectorDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/ConnectorStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "connectorEntity" + } + }, + "ConnectorPropertyAllowableValuesEntity" : { + "type" : "object", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "The allowable values for the property.", + "items" : { + "$ref" : "#/components/schemas/AllowableValueEntity" + } + }, + "configurationStepName" : { + "type" : "string", + "description" : "The name of the configuration step." + }, + "propertyGroupName" : { + "type" : "string", + "description" : "The name of the property group." + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property." + } + }, + "xml" : { + "name" : "connectorPropertyAllowableValuesEntity" + } + }, + "ConnectorPropertyDependency" : { + "type" : "object", + "description" : "The properties that this property depends on", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that enable this property", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that enable this property" + } + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property that this property depends on" + } + } + }, + "ConnectorPropertyDependencyDTO" : { + "type" : "object", + "description" : "The dependencies this property has on other properties.", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that must be set for this property to be applicable.", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that must be set for this property to be applicable." + }, + "uniqueItems" : true + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property that this property depends on." + } + } + }, + "ConnectorPropertyDescriptor" : { + "type" : "object", + "description" : "The properties in this group", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "The allowable values for this property", + "items" : { + "$ref" : "#/components/schemas/PropertyAllowableValue" + } + }, + "allowableValuesFetchable" : { + "type" : "boolean", + "description" : "Whether or not the allowable values can be fetched dynamically" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value of the property" + }, + "dependencies" : { + "type" : "array", + "description" : "The properties that this property depends on", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyDependency" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the property" + }, + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "propertyType" : { + "type" : "string", + "description" : "The type of the property", + "enum" : [ "STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST" ] + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + } + } + }, + "ConnectorPropertyDescriptorDTO" : { + "type" : "object", + "description" : "The property descriptors for this property group, keyed by property name.", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/components/schemas/AllowableValueEntity" + } + }, + "allowableValuesFetchable" : { + "type" : "boolean", + "description" : "Whether the allowable values are dynamically fetchable based on other property values." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "dependencies" : { + "type" : "array", + "description" : "The dependencies this property has on other properties.", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyDependencyDTO" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the property." + }, + "name" : { + "type" : "string", + "description" : "The name of the property." + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "type" : { + "type" : "string", + "description" : "The type of the property (STRING, INTEGER, BOOLEAN, DOUBLE, STRING_LIST)." + } + } + }, + "ConnectorPropertyGroup" : { + "type" : "object", + "description" : "The property groups in this configuration step", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the property group" + }, + "name" : { + "type" : "string", + "description" : "The name of the property group" + }, + "properties" : { + "type" : "array", + "description" : "The properties in this group", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyDescriptor" + } + } + } + }, + "ConnectorRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Connector.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectorStatusDTO" : { + "type" : "object", + "description" : "The status of the connector.", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ConnectorStatusSnapshotDTO" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group this connector belongs to." + }, + "id" : { + "type" : "string", + "description" : "The id of the connector." + }, + "name" : { + "type" : "string", + "description" : "The name of the connector." + }, + "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" : "#/components/schemas/NodeConnectorStatusSnapshotDTO" + } + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the connector." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed." + }, + "type" : { + "type" : "string", + "description" : "The type of the connector." + }, + "validationStatus" : { + "type" : "string", + "description" : "The validation status of the connector.", + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + } + } + }, + "ConnectorStatusSnapshotDTO" : { + "type" : "object", + "description" : "The connector status snapshot from the node.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the connector." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes queued in this connector's managed process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by processors in this connector's managed process group." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received by this connector's managed process group." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent by this connector's managed process group." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by processors in this connector's managed process group." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued in this connector's managed process group." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received by this connector's managed process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent by this connector's managed process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the connector belongs." + }, + "id" : { + "type" : "string", + "description" : "The id of the connector." + }, + "idle" : { + "type" : "boolean", + "description" : "Whether or not the connector is currently idle (no FlowFiles queued and no FlowFiles processed recently)." + }, + "idleDuration" : { + "type" : "string", + "description" : "A human-readable representation of how long the connector has been idle, or null if the connector is not idle." + }, + "idleDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of milliseconds the connector has been idle, or null if the connector is not idle." + }, + "name" : { + "type" : "string", + "description" : "The name of the connector." + }, + "processingPerformanceStatus" : { + "$ref" : "#/components/schemas/ProcessingPerformanceStatusDTO" + }, + "queued" : { + "type" : "string", + "description" : "The count/size of queued data, pretty-printed." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count of queued FlowFiles, pretty-printed." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size of queued data, pretty-printed." + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read, pretty-printed." + }, + "received" : { + "type" : "string", + "description" : "The count/size of data that has been received by this connector, pretty-printed." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the connector." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of data that has been sent by this connector, pretty-printed." + }, + "type" : { + "type" : "string", + "description" : "The type of the connector." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written, pretty-printed." + } + } + }, + "ConnectorTypesEntity" : { + "type" : "object", + "properties" : { + "connectorTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "connectorTypesEntity" + } + }, + "ConnectorValueReferenceDTO" : { + "type" : "object", + "description" : "The property values for this property group.", + "properties" : { + "assetReferences" : { + "type" : "array", + "description" : "The asset references. Applicable when valueType is ASSET_REFERENCE.", + "items" : { + "$ref" : "#/components/schemas/AssetReferenceDTO" + } + }, + "fullyQualifiedSecretName" : { + "type" : "string", + "description" : "The fully qualified secret name. Applicable when valueType is SECRET_REFERENCE." + }, + "secretName" : { + "type" : "string", + "description" : "The secret name. Applicable when valueType is SECRET_REFERENCE." + }, + "secretProviderId" : { + "type" : "string", + "description" : "The secret provider identifier. Applicable when valueType is SECRET_REFERENCE." + }, + "secretProviderName" : { + "type" : "string", + "description" : "The secret provider name. Applicable when valueType is SECRET_REFERENCE." + }, + "value" : { + "type" : "string", + "description" : "The string literal value. Applicable when valueType is STRING_LITERAL." + }, + "valueType" : { + "type" : "string", + "description" : "The type of value (STRING_LITERAL, ASSET_REFERENCE, or SECRET_REFERENCE)." + } + } + }, + "ConnectorsEntity" : { + "type" : "object", + "properties" : { + "connectors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ConnectorEntity" + }, + "uniqueItems" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + } + }, + "xml" : { + "name" : "connectorsEntity" + } + }, + "ContentViewerDTO" : { + "type" : "object", + "description" : "The Content Viewers.", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "The display name of the Content Viewer.", + "readOnly" : true + }, + "supportedMimeTypes" : { + "type" : "array", + "description" : "The mime types this Content Viewer supports.", + "items" : { + "$ref" : "#/components/schemas/SupportedMimeTypesDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The uri of the Content Viewer.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "ContentViewerEntity" : { + "type" : "object", + "properties" : { + "contentViewers" : { + "type" : "array", + "description" : "The Content Viewers.", + "items" : { + "$ref" : "#/components/schemas/ContentViewerDTO" + }, + "readOnly" : true + } + }, + "xml" : { + "name" : "contentViewerEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "flowAnalysisRuleBulletins" : { + "type" : "array", + "description" : "Flow Analysis Rule bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "flowRegistryClientBulletins" : { + "type" : "array", + "description" : "Flow registry client bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "parameterProviderBulletins" : { + "type" : "array", + "description" : "Parameter provider bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "description" : "The controller configuration.", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/ControllerConfigurationDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "id" : { + "type" : "string", + "description" : "The id of 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." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "items" : { + "$ref" : "#/components/schemas/PortDTO" + }, + "uniqueItems" : true + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "items" : { + "$ref" : "#/components/schemas/PortDTO" + }, + "uniqueItems" : true + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of FlowFiles. If this instance is not configured to receive FlowFiles from remote instances, this will be null." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The Socket Port on which this instance is listening for Remote Transfers of FlowFiles. If this instance is not configured to receive FlowFiles from remote instances, this will be null." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/components/schemas/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "description" : "Lists the APIs this Controller Service implements.", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "description" : "Lists the APIs this Controller Service implements.", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "description" : "The controller services in this flow snippet.", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceApiDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the controller service has been deprecated." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the controller service properties." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties of the controller service." + }, + "description" : "The properties of the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceReferencingComponentEntity" + }, + "uniqueItems" : true + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "items" : { + "type" : "string", + "description" : "Set of sensitive dynamic property names" + }, + "uniqueItems" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the controller service supports sensitive dynamic properties." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors from the controller service.\nThese validation errors represent the problems with the controller service that must be resolved before it can be enabled.\n", + "items" : { + "type" : "string", + "description" : "The validation errors from the controller service.\nThese validation errors represent the problems with the controller service that must be resolved before it can be enabled.\n" + } + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "description" : "Controller Services provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ControllerServiceDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/ControllerServiceStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the component 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." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component." + }, + "description" : "The properties for the component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask", "FlowRegistryClient", "ParameterProvider", "FlowAnalysisRule" ] + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceReferencingComponentEntity" + }, + "uniqueItems" : true + }, + "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." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string", + "description" : "The validation errors for the component." + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "description" : "All components referencing this controller service.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ControllerServiceReferencingComponentDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceReferencingComponentEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "uiOnly" : { + "type" : "boolean", + "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface.\nAs such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice.\nAs a result, this value should not be set to true by any client other than the UI.\n" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "description" : "The status for this ControllerService.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ], + "readOnly" : true + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "controllerServices" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceEntity" + }, + "uniqueItems" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of FlowFiles queued in the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components 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." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/components/schemas/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopyRequestEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "description" : "The ids of the connections to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the connections to be copied." + }, + "uniqueItems" : true + }, + "funnels" : { + "type" : "array", + "description" : "The ids of the funnels to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the funnels to be copied." + }, + "uniqueItems" : true + }, + "inputPorts" : { + "type" : "array", + "description" : "The ids of the input ports to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the input ports to be copied." + }, + "uniqueItems" : true + }, + "labels" : { + "type" : "array", + "description" : "The ids of the labels to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the labels to be copied." + }, + "uniqueItems" : true + }, + "outputPorts" : { + "type" : "array", + "description" : "The ids of the output ports to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the output ports to be copied." + }, + "uniqueItems" : true + }, + "processGroups" : { + "type" : "array", + "description" : "The ids of the process groups to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the process groups to be copied." + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The ids of the processors to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the processors to be copied." + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The ids of the remote process groups to be copied.", + "items" : { + "type" : "string", + "description" : "The ids of the remote process groups to be copied." + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "CopyResponseEntity" : { + "type" : "object", + "description" : "The response from copying.", + "properties" : { + "connections" : { + "type" : "array", + "description" : "The connections being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedConnection" + }, + "uniqueItems" : true + }, + "externalControllerServiceReferences" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ExternalControllerServiceReference" + }, + "description" : "The external controller service references." + }, + "funnels" : { + "type" : "array", + "description" : "The funnels being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedFunnel" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "The id for this copy action." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "labels" : { + "type" : "array", + "description" : "The labels being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedLabel" + }, + "uniqueItems" : true + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "parameterContexts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedParameterContext" + }, + "description" : "The referenced parameter contexts." + }, + "parameterProviders" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ParameterProviderReference" + }, + "description" : "The referenced parameter providers." + }, + "processGroups" : { + "type" : "array", + "description" : "The process groups being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessGroup" + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The processors being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessor" + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups being copied.", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteProcessGroup" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "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." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/components/schemas/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/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" : "#/components/schemas/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/components/schemas/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "description" : "The counters from the node.", + "properties" : { + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/components/schemas/CounterDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateFlowBranchRequestEntity" : { + "type" : "object", + "properties" : { + "branch" : { + "type" : "string", + "description" : "The name of the new branch to create" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "sourceBranch" : { + "type" : "string", + "description" : "The name of the source branch to create the new branch from. Defaults to the branch currently tracking in NiFi." + }, + "sourceVersion" : { + "type" : "string", + "description" : "The version on the source branch to use when creating the new branch. Defaults to the version currently tracked by NiFi." + } + }, + "xml" : { + "name" : "createFlowBranchRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "items" : { + "$ref" : "#/components/schemas/ComponentRestrictionPermissionDTO" + }, + "uniqueItems" : true + }, + "connectorsPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "controllerPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "countersPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "logoutSupported" : { + "type" : "boolean", + "description" : "Whether the system is configured to support logout operations based on current user authentication status", + "readOnly" : true + }, + "parameterContextPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "policiesPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "provenancePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "systemPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "tenantsPermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DateTimeParameter" : { + "type" : "object", + "properties" : { + "dateTime" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "DefinedType" : { + "type" : "object", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "properties" : { + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "DifferenceDTO" : { + "type" : "object", + "description" : "The differences in the component between the two flows", + "properties" : { + "difference" : { + "type" : "string", + "description" : "Description of the difference" + }, + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "environmental" : { + "type" : "boolean", + "description" : "Whether this difference is environmental (e.g., bundle version change due to NiFi upgrade) rather than a user-initiated change. Environmental changes are typically not reverted when reverting local changes." + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceApiDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enforced.", + "items" : { + "$ref" : "#/components/schemas/ExplicitRestrictionDTO" + }, + "uniqueItems" : true + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "items" : { + "type" : "string", + "description" : "The tags associated with this type." + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "current" : { + "type" : "string", + "description" : "The count and size of FlowFiles currently queued." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of FlowFiles currently queued in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of FlowFiles that have been dropped thus far." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of FlowFiles that have been dropped thus far in bytes." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "original" : { + "type" : "string", + "description" : "The count and size of FlowFiles to be dropped as a result of this request." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of FlowFiles to be dropped as a result of this request in bytes." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/components/schemas/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "DynamicProperty" : { + "type" : "object", + "description" : "Describes the dynamic properties supported by this component", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "ENVIRONMENT", "FLOWFILE_ATTRIBUTES" ] + }, + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "description" : "If the processor supports dynamic relationships, this describes the dynamic relationship", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + }, + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + } + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enforced.", + "properties" : { + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + }, + "requiredPermission" : { + "$ref" : "#/components/schemas/RequiredPermissionDTO" + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowAnalysisResultEntity" : { + "type" : "object", + "properties" : { + "flowAnalysisPending" : { + "type" : "boolean" + }, + "ruleViolations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleViolationDTO" + } + }, + "rules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleDTO" + } + } + }, + "xml" : { + "name" : "flowAnalysisResultEntity" + } + }, + "FlowAnalysisRuleDTO" : { + "type" : "object", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "comments" : { + "type" : "string", + "description" : "The comments of the flow analysis rule." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the flow analysis rule has been deprecated." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the flow analysis rules properties." + }, + "enforcementPolicy" : { + "type" : "string", + "description" : "Enforcement Policy." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the flow analysis rule has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The name of the flow analysis rule." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the flow analysis rule persists state." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties of the flow analysis rule." + }, + "description" : "The properties of the flow analysis rule." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the flow analysis rule requires elevated privileges." + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "items" : { + "type" : "string", + "description" : "Set of sensitive dynamic property names" + }, + "uniqueItems" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the flow analysis rule.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the flow analysis rule supports sensitive dynamic properties." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the flow analysis rule." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the flow analysis rule. These validation errors represent the problems with the flow analysis rule that must be resolved before it can be scheduled to run.", + "items" : { + "type" : "string", + "description" : "Gets the validation errors from the flow analysis rule. These validation errors represent the problems with the flow analysis rule that must be resolved before it can be scheduled to run." + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Flow Analysis Rule is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Flow Analysis Rule is valid)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "FlowAnalysisRuleDefinition" : { + "type" : "object", + "description" : "Flow Analysis Rules provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "FlowAnalysisRuleEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "flowAnalysisRuleEntity" + } + }, + "FlowAnalysisRuleRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the FlowAnalysisRule.", + "enum" : [ "ENABLED", "DISABLED" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "FlowAnalysisRuleStatusDTO" : { + "type" : "object", + "description" : "The status for this FlowAnalysisRule.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of this FlowAnalysisRule", + "enum" : [ "ENABLED", "DISABLED" ], + "readOnly" : true + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "FlowAnalysisRuleTypesEntity" : { + "type" : "object", + "properties" : { + "flowAnalysisRuleTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "flowAnalysisRuleTypesEntity" + } + }, + "FlowAnalysisRuleViolationDTO" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean" + }, + "enforcementPolicy" : { + "type" : "string" + }, + "groupId" : { + "type" : "string" + }, + "issueId" : { + "type" : "string" + }, + "ruleId" : { + "type" : "string" + }, + "scope" : { + "type" : "string" + }, + "subjectComponentType" : { + "type" : "string" + }, + "subjectDisplayName" : { + "type" : "string" + }, + "subjectId" : { + "type" : "string" + }, + "subjectPermissionDto" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "violationMessage" : { + "type" : "string" + } + } + }, + "FlowAnalysisRulesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "flowAnalysisRules" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowAnalysisRuleEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "flowAnalysisRulesEntity" + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "description" : "This breadcrumb.", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "$ref" : "#/components/schemas/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "description" : "The breadcrumb of the process group.", + "properties" : { + "breadcrumb" : { + "$ref" : "#/components/schemas/FlowBreadcrumbDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "parentBreadcrumb" : { + "$ref" : "#/components/schemas/FlowBreadcrumbEntity" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ], + "readOnly" : true + } + }, + "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", + "items" : { + "$ref" : "#/components/schemas/ComponentDifferenceDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "description" : "The controller configuration.", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "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 + }, + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "$ref" : "#/components/schemas/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "description" : "Flow containing the components that were created as part of this paste action.", + "properties" : { + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "items" : { + "$ref" : "#/components/schemas/ConnectionEntity" + }, + "uniqueItems" : true + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "items" : { + "$ref" : "#/components/schemas/FunnelEntity" + }, + "uniqueItems" : true + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "items" : { + "$ref" : "#/components/schemas/PortEntity" + }, + "uniqueItems" : true + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "items" : { + "$ref" : "#/components/schemas/LabelEntity" + }, + "uniqueItems" : true + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "items" : { + "$ref" : "#/components/schemas/PortEntity" + }, + "uniqueItems" : true + }, + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "items" : { + "$ref" : "#/components/schemas/ProcessGroupEntity" + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "items" : { + "$ref" : "#/components/schemas/ProcessorEntity" + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupEntity" + }, + "uniqueItems" : true + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/components/schemas/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "attributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The FlowFile attributes." + }, + "description" : "The FlowFile attributes." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "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." + }, + "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." + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "mimeType" : { + "type" : "string", + "description" : "The FlowFile mime type." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/components/schemas/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "properties" : { + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "mimeType" : { + "type" : "string", + "description" : "The FlowFile mime type." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + } + } + }, + "FlowRegistryBranchDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The branch name" + } + } + }, + "FlowRegistryBranchEntity" : { + "type" : "object", + "properties" : { + "branch" : { + "$ref" : "#/components/schemas/FlowRegistryBranchDTO" + } + }, + "xml" : { + "name" : "branchEntity" + } + }, + "FlowRegistryBranchesEntity" : { + "type" : "object", + "properties" : { + "branches" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowRegistryBranchEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "branches" + } + }, + "FlowRegistryBucket" : { + "type" : "object", + "properties" : { + "createdTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "identifier" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "permissions" : { + "$ref" : "#/components/schemas/FlowRegistryPermissions" + } + } + }, + "FlowRegistryBucketDTO" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + } + } + }, + "FlowRegistryBucketEntity" : { + "type" : "object", + "properties" : { + "bucket" : { + "$ref" : "#/components/schemas/FlowRegistryBucketDTO" + }, + "id" : { + "type" : "string" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "FlowRegistryBucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowRegistryBucketEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "FlowRegistryClientDTO" : { + "type" : "object", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the registry client. This is how the custom UI relays configuration to the registry client." + }, + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the registry client has been deprecated." + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the registry client properties." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the flow registry client has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties of the registry client." + }, + "description" : "The properties of the registry client." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the registry client requires elevated privileges." + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "items" : { + "type" : "string", + "description" : "Set of sensitive dynamic property names" + }, + "uniqueItems" : true + }, + "supportsBranching" : { + "type" : "boolean", + "description" : "Whether the registry client supports branching." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the registry client supports sensitive dynamic properties." + }, + "type" : { + "type" : "string", + "description" : "The type of the registry client." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the registry client. These validation errors represent the problems with the registry client that must be resolved before it can be used for interacting with the flow registry.", + "items" : { + "type" : "string", + "description" : "Gets the validation errors from the registry client. These validation errors represent the problems with the registry client that must be resolved before it can be used for interacting with the flow registry." + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Registry Client is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Registry Client is valid)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + } + } + }, + "FlowRegistryClientDefinition" : { + "type" : "object", + "description" : "Flow Registry Clients provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "FlowRegistryClientEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/FlowRegistryClientDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "FlowRegistryClientTypesEntity" : { + "type" : "object", + "properties" : { + "flowRegistryClientTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "flowRegistryClientTypesEntity" + } + }, + "FlowRegistryClientsEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "registries" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FlowRegistryClientEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "FlowRegistryPermissions" : { + "type" : "object", + "properties" : { + "canDelete" : { + "type" : "boolean" + }, + "canRead" : { + "type" : "boolean" + }, + "canWrite" : { + "type" : "boolean" + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "description" : "The contents of this process group.", + "properties" : { + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/ConnectionDTO" + }, + "uniqueItems" : true + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceDTO" + }, + "uniqueItems" : true + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/FunnelDTO" + }, + "uniqueItems" : true + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/PortDTO" + }, + "uniqueItems" : true + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/LabelDTO" + }, + "uniqueItems" : true + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/PortDTO" + }, + "uniqueItems" : true + }, + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/ProcessGroupDTO" + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/ProcessorDTO" + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupDTO" + }, + "uniqueItems" : true + } + } + }, + "FunnelDTO" : { + "type" : "object", + "description" : "The funnels in this flow snippet.", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "description" : "The funnels in this flow.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/FunnelDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/FunnelEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "description" : "The garbage collection details.", + "properties" : { + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/components/schemas/ActionEntity" + } + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/components/schemas/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PortEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "IntegerParameter" : { + "type" : "object", + "properties" : { + "integer" : { + "type" : "integer", + "format" : "int32" + } + } + }, + "JmxMetricsResultDTO" : { + "type" : "object", + "properties" : { + "attributeName" : { + "type" : "string", + "description" : "The attribute name of the metrics bean's attribute." + }, + "attributeValue" : { + "type" : "object", + "description" : "The attribute value of the the metrics bean's attribute" + }, + "beanName" : { + "type" : "string", + "description" : "The bean name of the metrics bean." + } + } + }, + "JmxMetricsResultsEntity" : { + "type" : "object", + "properties" : { + "jmxMetricsResults" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/JmxMetricsResultDTO" + } + } + }, + "xml" : { + "name" : "jmxMetricsResult" + } + }, + "LabelDTO" : { + "type" : "object", + "description" : "The labels in this flow snippet.", + "properties" : { + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the label." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + } + } + }, + "LabelEntity" : { + "type" : "object", + "description" : "The labels in this flow.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/LabelDTO" + }, + "dimensions" : { + "$ref" : "#/components/schemas/DimensionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the label." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LabelEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LatestProvenanceEventsDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string" + }, + "provenanceEvents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProvenanceEventDTO" + } + } + } + }, + "LatestProvenanceEventsEntity" : { + "type" : "object", + "properties" : { + "latestProvenanceEvents" : { + "$ref" : "#/components/schemas/LatestProvenanceEventsDTO" + } + }, + "xml" : { + "name" : "latestProvenanceEventsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "request" : { + "$ref" : "#/components/schemas/LineageRequestDTO" + }, + "results" : { + "$ref" : "#/components/schemas/LineageResultsDTO" + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/components/schemas/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "description" : "The initial lineage result.", + "properties" : { + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id that was used to generate this lineage, if applicable.\nThe event id is allowed for any type of lineageRequestType.\nIf the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored.\n" + }, + "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", "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." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "description" : "The results of the lineage query.", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "items" : { + "type" : "string", + "description" : "Any errors that occurred while generating the lineage." + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/components/schemas/ProvenanceLinkDTO" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/components/schemas/ProvenanceNodeDTO" + } + } + } + }, + "ListenPortDTO" : { + "type" : "object", + "description" : "A list of ingress ports that are currently configured", + "properties" : { + "applicationProtocols" : { + "type" : "array", + "description" : "Supported application protocols, if applicable", + "items" : { + "type" : "string", + "description" : "Supported application protocols, if applicable" + } + }, + "componentClass" : { + "type" : "string", + "description" : "The class type of the component providing the listen port" + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component providing the listen port" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component providing the listen port" + }, + "componentType" : { + "type" : "string", + "description" : "The type of component providing the listen port (e.g., Processor, ControllerService)" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of the process group containing the component providing the listen port, if applicable" + }, + "parentGroupName" : { + "type" : "string", + "description" : "The name of the process group containing the component providing the listen port, if applicable" + }, + "portName" : { + "type" : "string", + "description" : "The name of the the listen port. Useful context for components that provide multiple ports." + }, + "portNumber" : { + "type" : "integer", + "format" : "int32", + "description" : "The ingress port number" + }, + "transportProtocol" : { + "type" : "string", + "description" : "The ingress transport protocol (TCP or UDP)" + } + } + }, + "ListenPortsEntity" : { + "type" : "object", + "properties" : { + "listenPorts" : { + "type" : "array", + "description" : "A list of ingress ports that are currently configured", + "items" : { + "$ref" : "#/components/schemas/ListenPortDTO" + } + } + }, + "xml" : { + "name" : "listenPortsEntity" + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/components/schemas/FlowFileSummaryDTO" + } + }, + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "queueSize" : { + "$ref" : "#/components/schemas/QueueSizeDTO" + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/components/schemas/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "LongParameter" : { + "type" : "object", + "properties" : { + "long" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "MigrationPayloadDTO" : { + "type" : "object", + "description" : "The uploaded migration payload metadata.", + "properties" : { + "payloadId" : { + "type" : "string", + "description" : "The identifier of the uploaded migration payload." + } + } + }, + "MigrationPayloadEntity" : { + "type" : "object", + "properties" : { + "payload" : { + "$ref" : "#/components/schemas/MigrationPayloadDTO" + } + }, + "xml" : { + "name" : "migrationPayloadEntity" + } + }, + "MigrationRequestDTO" : { + "type" : "object", + "description" : "The migration request.", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "connectorId" : { + "type" : "string", + "description" : "The identifier of the Connector receiving the migration." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "localSource" : { + "$ref" : "#/components/schemas/MigrationRequestLocalSourceDTO" + }, + "payloadId" : { + "type" : "string", + "description" : "The identifier of a previously uploaded migration payload." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/MigrationUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "MigrationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "$ref" : "#/components/schemas/MigrationRequestDTO" + } + }, + "xml" : { + "name" : "migrationRequestEntity" + } + }, + "MigrationRequestLocalSourceDTO" : { + "type" : "object", + "description" : "The local Process Group source for the migration request.", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The identifier of the local source Process Group to migrate." + } + } + }, + "MigrationUpdateStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MultiProcessorUseCase" : { + "type" : "object", + "description" : "A list of use cases that have been documented that involve this Processor in conjunction with other Processors", + "properties" : { + "configurations" : { + "type" : "array", + "description" : "A description of how to configure the Processor to perform the task described in the use case", + "items" : { + "$ref" : "#/components/schemas/ProcessorConfiguration" + } + }, + "description" : { + "type" : "string", + "description" : "A description of the use case" + }, + "keywords" : { + "type" : "array", + "description" : "Keywords that pertain to the use csae", + "items" : { + "type" : "string", + "description" : "Keywords that pertain to the use csae" + } + }, + "notes" : { + "type" : "string", + "description" : "Any pertinent notes about the use case" + } + } + }, + "NarCoordinateDTO" : { + "type" : "object", + "description" : "The coordinate of another NAR that the this NAR is dependent on, or null if not dependent on another NAR.", + "properties" : { + "artifact" : { + "type" : "string", + "description" : "The artifact id of the NAR." + }, + "group" : { + "type" : "string", + "description" : "The group of the NAR." + }, + "version" : { + "type" : "string", + "description" : "The version of the NAR." + } + } + }, + "NarDetailsEntity" : { + "type" : "object", + "properties" : { + "connectorTypes" : { + "type" : "array", + "description" : "The Connector types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "controllerServiceTypes" : { + "type" : "array", + "description" : "The ControllerService types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "dependentCoordinates" : { + "type" : "array", + "description" : "The coordinates of NARs that depend on this NAR", + "items" : { + "$ref" : "#/components/schemas/NarCoordinateDTO" + }, + "uniqueItems" : true + }, + "flowAnalysisRuleTypes" : { + "type" : "array", + "description" : "The FlowAnalysisRule types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "flowRegistryClientTypes" : { + "type" : "array", + "description" : "The FlowRegistryClient types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "narSummary" : { + "$ref" : "#/components/schemas/NarSummaryDTO" + }, + "parameterProviderTypes" : { + "type" : "array", + "description" : "The ParameterProvider types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "processorTypes" : { + "type" : "array", + "description" : "The Processor types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + }, + "reportingTaskTypes" : { + "type" : "array", + "description" : "The ReportingTask types contained in the NAR", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "NarSummariesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "narSummaries" : { + "type" : "array", + "description" : "The NAR summaries", + "items" : { + "$ref" : "#/components/schemas/NarSummaryEntity" + } + } + }, + "xml" : { + "name" : "entity" + } + }, + "NarSummaryDTO" : { + "type" : "object", + "description" : "The NAR summary", + "properties" : { + "buildTime" : { + "type" : "string", + "description" : "The time the NAR was built according to it's MANIFEST" + }, + "coordinate" : { + "$ref" : "#/components/schemas/NarCoordinateDTO" + }, + "createdBy" : { + "type" : "string", + "description" : "The plugin that created the NAR according to it's MANIFEST" + }, + "dependencyCoordinate" : { + "$ref" : "#/components/schemas/NarCoordinateDTO" + }, + "digest" : { + "type" : "string", + "description" : "The hex digest of the NAR contents" + }, + "extensionCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extensions contained in this NAR" + }, + "failureMessage" : { + "type" : "string", + "description" : "Information about why the installation failed, only populated when the state is failed" + }, + "identifier" : { + "type" : "string", + "description" : "The identifier of the NAR." + }, + "installComplete" : { + "type" : "boolean", + "description" : "Indicates if the install task has completed" + }, + "sourceIdentifier" : { + "type" : "string", + "description" : "The identifier of the source of this NAR" + }, + "sourceType" : { + "type" : "string", + "description" : "The source of this NAR" + }, + "state" : { + "type" : "string", + "description" : "The state of the NAR (i.e. Installed, or not)" + } + } + }, + "NarSummaryEntity" : { + "type" : "object", + "properties" : { + "narSummary" : { + "$ref" : "#/components/schemas/NarSummaryDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "description" : "A list of status snapshots for each node", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statisticsSnapshot" : { + "$ref" : "#/components/schemas/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "description" : "A list of status snapshots for each node", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeConnectorStatusSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/ConnectorStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "snapshot" : { + "$ref" : "#/components/schemas/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on 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 + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The total size of all FlowFiles that are queued up on the node", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "items" : { + "$ref" : "#/components/schemas/NodeEventDTO" + }, + "readOnly" : true + }, + "flowFileBytes" : { + "type" : "integer", + "format" : "int64", + "writeOnly" : true + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up on the node", + "readOnly" : true + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "items" : { + "type" : "string", + "description" : "The roles of this node.", + "readOnly" : true + }, + "readOnly" : true, + "uniqueItems" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/components/schemas/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "description" : "The node's events.", + "properties" : { + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + } + }, + "readOnly" : true + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "statusSnapshot" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeReplayLastEventSnapshotDTO" : { + "type" : "object", + "description" : "The node-wise results", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "snapshot" : { + "$ref" : "#/components/schemas/ReplayLastEventSnapshotDTO" + } + }, + "xml" : { + "name" : "nodeReplayLastEventSnapshot" + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + }, + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "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.", + "properties" : { + "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." + }, + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/components/schemas/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "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.", + "properties" : { + "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" + }, + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "snapshot" : { + "$ref" : "#/components/schemas/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PortEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "properties" : { + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "items" : { + "$ref" : "#/components/schemas/ProcessGroupEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "A list of references of Parameter Contexts from which this one inherits parameters", + "items" : { + "$ref" : "#/components/schemas/ParameterContextReferenceEntity" + } + }, + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "parameterProviderConfiguration" : { + "$ref" : "#/components/schemas/ParameterProviderConfigurationEntity" + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "items" : { + "$ref" : "#/components/schemas/ParameterEntity" + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ParameterContextDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "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", + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/ParameterContextReferenceDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateEntity" : { + "type" : "object", + "description" : "The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.", + "properties" : { + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextDTO" + }, + "parameterContextRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "items" : { + "$ref" : "#/components/schemas/AffectedComponentEntity" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true, + "xml" : { + "name" : "parameterContextUpdateEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "description" : "The Update Request", + "properties" : { + "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 + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextDTO" + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "items" : { + "$ref" : "#/components/schemas/AffectedComponentEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/ParameterContextUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "request" : { + "$ref" : "#/components/schemas/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "description" : "The Update Request", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "componentValidationResults" : { + "$ref" : "#/components/schemas/ComponentValidationResultsEntity" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextDTO" + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/ParameterContextValidationStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "request" : { + "$ref" : "#/components/schemas/ParameterContextValidationRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + }, + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "items" : { + "$ref" : "#/components/schemas/ParameterContextEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "description" : "The parameter information", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "inherited" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is inherited from another context", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextReferenceEntity" + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is provided by a ParameterProvider" + }, + "referencedAssets" : { + "type" : "array", + "description" : "A list of identifiers of the assets that are referenced by the parameter", + "items" : { + "$ref" : "#/components/schemas/AssetReferenceDTO" + } + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "items" : { + "$ref" : "#/components/schemas/AffectedComponentEntity" + }, + "uniqueItems" : true + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "valueRemoved" : { + "type" : "boolean", + "description" : "Whether or not the value of the Parameter was removed.\nWhen a request is made to change a parameter, the value may be null.\nThe absence of the value may be used either to indicate that the value is not to be changed, or that the value is to be set to null (i.e., removed).\nThis denotes which of the two scenarios is being encountered.\n" + } + } + }, + "ParameterEntity" : { + "type" : "object", + "description" : "The name of the Parameter", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "$ref" : "#/components/schemas/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "ParameterGroupConfigurationEntity" : { + "type" : "object", + "description" : "Configuration for any fetched parameter groups.", + "properties" : { + "groupName" : { + "type" : "string", + "description" : "The name of the external parameter group to which the provided parameter names apply." + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the ParameterContext that receives the parameters in this group" + }, + "parameterSensitivities" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "All fetched parameter names that should be applied.", + "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] + }, + "description" : "All fetched parameter names that should be applied." + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if this group should be synchronized to a ParameterContext, including creating one if it does not exist." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderApplyParametersRequestDTO" : { + "type" : "object", + "description" : "The Apply Parameters Request", + "properties" : { + "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 + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "parameterContextUpdates" : { + "type" : "array", + "description" : "The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.", + "items" : { + "$ref" : "#/components/schemas/ParameterContextUpdateEntity" + }, + "readOnly" : true + }, + "parameterProvider" : { + "$ref" : "#/components/schemas/ParameterProviderDTO" + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "items" : { + "$ref" : "#/components/schemas/AffectedComponentEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/ParameterProviderApplyParametersUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "ParameterProviderApplyParametersRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "$ref" : "#/components/schemas/ParameterProviderApplyParametersRequestDTO" + } + }, + "xml" : { + "name" : "parameterProviderApplyParametersRequestEntity" + } + }, + "ParameterProviderApplyParametersUpdateStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "ParameterProviderConfigurationDTO" : { + "type" : "object", + "properties" : { + "parameterGroupName" : { + "type" : "string", + "description" : "The Parameter Group name that maps to the Parameter Context" + }, + "parameterProviderId" : { + "type" : "string", + "description" : "The ID of the Parameter Provider" + }, + "parameterProviderName" : { + "type" : "string", + "description" : "The name of the Parameter Provider" + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" + } + } + }, + "ParameterProviderConfigurationEntity" : { + "type" : "object", + "description" : "Optional configuration for a Parameter Provider", + "properties" : { + "component" : { + "$ref" : "#/components/schemas/ParameterProviderConfigurationDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + } + }, + "xml" : { + "name" : "parameterProviderConfigurationEntity" + } + }, + "ParameterProviderDTO" : { + "type" : "object", + "properties" : { + "affectedComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", + "items" : { + "$ref" : "#/components/schemas/AffectedComponentEntity" + }, + "uniqueItems" : true + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider." + }, + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "comments" : { + "type" : "string", + "description" : "The comments of the parameter provider." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the parameter provider." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the parameter provider has been deprecated." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the parameter providers properties." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the parameter provider has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider." + }, + "parameterGroupConfigurations" : { + "type" : "array", + "description" : "Configuration for any fetched parameter groups.", + "items" : { + "$ref" : "#/components/schemas/ParameterGroupConfigurationEntity" + } + }, + "parameterStatus" : { + "type" : "array", + "description" : "The status of all provided parameters for this parameter provider", + "items" : { + "$ref" : "#/components/schemas/ParameterStatusDTO" + }, + "uniqueItems" : true + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the parameter provider persists state." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties of the parameter provider." + }, + "description" : "The properties of the parameter provider." + }, + "referencingParameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts that reference this Parameter Provider", + "items" : { + "$ref" : "#/components/schemas/ParameterProviderReferencingComponentEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the parameter provider requires elevated privileges." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the parameter provider." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run.", + "items" : { + "type" : "string", + "description" : "Gets the validation errors from the parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run." + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ParameterProviderDefinition" : { + "type" : "object", + "description" : "Parameter Providers provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "ParameterProviderEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ParameterProviderDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "parameterProviderEntity" + } + }, + "ParameterProviderParameterApplicationEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the parameter provider." + }, + "parameterGroupConfigurations" : { + "type" : "array", + "description" : "Configuration for the fetched Parameter Groups", + "items" : { + "$ref" : "#/components/schemas/ParameterGroupConfigurationEntity" + } + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderParameterFetchEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the parameter provider." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderReference" : { + "type" : "object", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "identifier" : { + "type" : "string", + "description" : "The identifier of the parameter provider" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the parameter provider class." + } + } + }, + "ParameterProviderReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component referencing a parameter provider." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a parameter provider." + } + } + }, + "ParameterProviderReferencingComponentEntity" : { + "type" : "object", + "description" : "The Parameter Contexts that reference this Parameter Provider", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ParameterProviderReferencingComponentDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "readOnly" : true, + "xml" : { + "name" : "parameterProviderReferencingComponentEntity" + } + }, + "ParameterProviderReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "parameterProviderReferencingComponents" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterProviderReferencingComponentEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "parameterProviderReferencingComponentsEntity" + } + }, + "ParameterProviderTypesEntity" : { + "type" : "object", + "properties" : { + "parameterProviderTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "parameterProviderTypesEntity" + } + }, + "ParameterProvidersEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "parameterProviders" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ParameterProviderEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "parameterProvidersEntity" + } + }, + "ParameterStatusDTO" : { + "type" : "object", + "description" : "The status of all provided parameters for this parameter provider", + "properties" : { + "parameter" : { + "$ref" : "#/components/schemas/ParameterEntity" + }, + "status" : { + "type" : "string", + "description" : "Indicates the status of the parameter, compared to the existing parameter context", + "enum" : [ "NEW", "CHANGED", "REMOVED", "MISSING_BUT_REFERENCED", "UNCHANGED" ] + } + } + }, + "PasteRequestEntity" : { + "type" : "object", + "properties" : { + "copyResponse" : { + "$ref" : "#/components/schemas/CopyResponseEntity" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "PasteResponseEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/components/schemas/FlowDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + }, + "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." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "PermissionsDTO" : { + "type" : "object", + "description" : "The permissions for this component.", + "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", + "description" : "The output ports available to received data from the NiFi.", + "properties" : { + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "portFunction" : { + "type" : "string", + "description" : "Specifies how the Port functions", + "enum" : [ "STANDARD", "FAILURE" ] + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "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." + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "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", + "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." + } + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "PortEntity" : { + "type" : "object", + "description" : "The output ports in this flow.", + "properties" : { + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/PortDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "portType" : { + "type" : "string" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/PortStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "description" : "The status of the port.", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/PortStatusSnapshotDTO" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "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" : "#/components/schemas/NodePortStatusSnapshotDTO" + } + }, + "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." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "portStatus" : { + "$ref" : "#/components/schemas/PortStatusDTO" + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number 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." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "input" : { + "type" : "string", + "description" : "The count/size of FlowFiles that have been accepted in the last 5 minutes." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "output" : { + "type" : "string", + "description" : "The count/size of FlowFiles that have been processed in the last 5 minutes." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "description" : "The status of all output ports in the process group.", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/components/schemas/PortStatusSnapshotDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "description" : "The position of a component on the graph", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PositionDTO" : { + "type" : "object", + "description" : "The position of this component in the UI if applicable.", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "description" : "Previous values for a given property.", + "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", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "contents" : { + "$ref" : "#/components/schemas/FlowSnippetDTO" + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "executionEngine" : { + "type" : "string", + "description" : "The Execution Engine that should be used to run the flow represented by this Process Group.", + "enum" : [ "STATELESS", "STANDARD", "INHERITED" ] + }, + "flowfileConcurrency" : { + "type" : "string", + "description" : "The FlowFile Concurrency for this Process Group.", + "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "SINGLE_BATCH_PER_NODE" ] + }, + "flowfileOutboundPolicy" : { + "type" : "string", + "description" : "The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", + "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "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." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale 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." + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "maxConcurrentTasks" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of concurrent tasks to use when running the flow using the Stateless Engine" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextReferenceEntity" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "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." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "statelessFlowTimeout" : { + "type" : "string", + "description" : "The maximum amount of time that the flow can be run using the Stateless Engine before the flow times out" + }, + "statelessGroupScheduledState" : { + "type" : "string", + "description" : "If the Process Group is configured to run in using the Stateless Engine, represents the current state. Otherwise, will be STOPPED.", + "enum" : [ "STOPPED", "RUNNING" ] + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components 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." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "versionControlInformation" : { + "$ref" : "#/components/schemas/VersionControlInformationDTO" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ProcessGroupDTO" + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "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." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale 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." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextReferenceEntity" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "processGroupUpdateStrategy" : { + "type" : "string", + "description" : "Determines the process group update strategy", + "enum" : [ "CURRENT_GROUP", "CURRENT_GROUP_WITH_CHILDREN" ] + }, + "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." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "status" : { + "$ref" : "#/components/schemas/ProcessGroupStatusDTO" + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components 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." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "versionedFlowSnapshot" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ], + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "breadcrumb" : { + "$ref" : "#/components/schemas/FlowBreadcrumbEntity" + }, + "flow" : { + "$ref" : "#/components/schemas/FlowDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + }, + "parameterContext" : { + "$ref" : "#/components/schemas/ParameterContextReferenceEntity" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/components/schemas/ProcessGroupFlowDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupImportEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "versionedFlowSnapshot" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupImportEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "description" : "The Process Group that the component belongs to", + "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", + "description" : "The Process Group Change Request", + "properties" : { + "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 + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + } + } + }, + "ProcessGroupReplaceRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "request" : { + "$ref" : "#/components/schemas/ProcessGroupReplaceRequestDTO" + }, + "versionedFlowSnapshot" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupReplaceRequestEntity" + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "description" : "The status of the process group.", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ProcessGroupStatusSnapshotDTO" + }, + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "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" : "#/components/schemas/NodeProcessGroupStatusSnapshotDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "processGroupStatus" : { + "$ref" : "#/components/schemas/ProcessGroupStatusDTO" + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "description" : "The process group status snapshot from the node.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into 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" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup 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" + }, + "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" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup 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" + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/components/schemas/ConnectionStatusSnapshotEntity" + } + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup 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" + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources 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" + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/components/schemas/PortStatusSnapshotEntity" + } + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/components/schemas/PortStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/components/schemas/ProcessGroupStatusSnapshotEntity" + } + }, + "processingNanos" : { + "type" : "integer", + "format" : "int64" + }, + "processingPerformanceStatus" : { + "$ref" : "#/components/schemas/ProcessingPerformanceStatusDTO" + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/components/schemas/ProcessorStatusSnapshotEntity" + } + }, + "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." + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "statelessActiveThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The current number of active threads for the Process Group, when running in Stateless mode.", + "readOnly" : true + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ], + "readOnly" : true + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "description" : "The status of all process groups in the process group.", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/components/schemas/ProcessGroupStatusSnapshotDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupUploadEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean" + }, + "flowSnapshot" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + }, + "groupId" : { + "type" : "string" + }, + "groupName" : { + "type" : "string" + }, + "positionDTO" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revisionDTO" : { + "$ref" : "#/components/schemas/RevisionDTO" + } + }, + "xml" : { + "name" : "processGroupUploadEntity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessGroupEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessingPerformanceStatusDTO" : { + "type" : "object", + "description" : "Represents the processor's processing performance.", + "properties" : { + "contentReadDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds has spent to read content in the last 5 minutes." + }, + "contentWriteDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds has spent to write content in the last 5 minutes." + }, + "cpuDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds has spent on CPU usage in the last 5 minutes." + }, + "garbageCollectionDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds has spent running garbage collection in the last 5 minutes." + }, + "identifier" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "sessionCommitDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds has spent running to commit sessions the last 5 minutes." + } + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the processor." + }, + "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.", + "items" : { + "type" : "string", + "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 + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR. See BackoffMechanism.class for more details." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy." + }, + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy." + }, + "description" : "Maps default values for scheduling period for each applicable scheduling strategy." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "Descriptors for the processor's properties." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "items" : { + "type" : "string", + "description" : "All the relationships should be retried." + }, + "uniqueItems" : true + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "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" : "Indicates how the processor should be scheduled to run." + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "items" : { + "type" : "string", + "description" : "Set of sensitive dynamic property names" + }, + "uniqueItems" : true + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + } + } + }, + "ProcessorConfiguration" : { + "type" : "object", + "description" : "A description of how to configure the Processor to perform the task described in the use case", + "properties" : { + "configuration" : { + "type" : "string", + "description" : "A description of how the Processor should be configured in order to accomplish the use case" + }, + "processorClassName" : { + "type" : "string", + "description" : "The fully qualified classname of the Processor that should be used to accomplish the use case" + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "config" : { + "$ref" : "#/components/schemas/ProcessorConfigDTO" + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "physicalState" : { + "type" : "string", + "description" : "The physical state of the processor, including transition states", + "enum" : [ "RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE" ] + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "items" : { + "$ref" : "#/components/schemas/RelationshipDTO" + }, + "readOnly" : true + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Styles for the processor (background-color : #eee)." + }, + "description" : "Styles for the processor (background-color : #eee)." + }, + "supportsBacklogReporting" : { + "type" : "boolean", + "description" : "Whether the processor implements BacklogReportingProcessor and can report a backlog." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the processor supports sensitive dynamic properties." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "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", + "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." + } + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ProcessorDefinition" : { + "type" : "object", + "description" : "Processors provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "defaultBulletinLevel" : { + "type" : "string", + "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." + }, + "defaultConcurrentTasksBySchedulingStrategy" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The default concurrent tasks for each scheduling strategy." + }, + "description" : "The default concurrent tasks for each scheduling strategy." + }, + "defaultPenaltyDuration" : { + "type" : "string", + "description" : "The default penalty duration as a time period, such as \"30 sec\"." + }, + "defaultSchedulingPeriodBySchedulingStrategy" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\"." + }, + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\"." + }, + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The default scheduling strategy for the processor." + }, + "defaultYieldDuration" : { + "type" : "string", + "description" : "The default yield duration as a time period, such as \"1 sec\"." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "dynamicRelationship" : { + "$ref" : "#/components/schemas/DynamicRelationship" + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "inputRequirement" : { + "type" : "string", + "description" : "Any input requirements this processor has.", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "multiProcessorUseCases" : { + "type" : "array", + "description" : "A list of use cases that have been documented that involve this Processor in conjunction with other Processors", + "items" : { + "$ref" : "#/components/schemas/MultiProcessorUseCase" + } + }, + "primaryNodeOnly" : { + "type" : "boolean", + "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "readsAttributes" : { + "type" : "array", + "description" : "The FlowFile attributes this processor reads", + "items" : { + "$ref" : "#/components/schemas/Attribute" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "sideEffectFree" : { + "type" : "boolean", + "description" : "Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor's operations on FlowFiles can be safely repeated across process sessions." + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportedRelationships" : { + "type" : "array", + "description" : "The supported relationships for this processor.", + "items" : { + "$ref" : "#/components/schemas/Relationship" + } + }, + "supportedSchedulingStrategies" : { + "type" : "array", + "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", + "items" : { + "type" : "string", + "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN." + } + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times." + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsDynamicRelationships" : { + "type" : "boolean", + "description" : "Whether or not this processor supports dynamic relationships." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "triggerSerially" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." + }, + "triggerWhenAnyDestinationAvailable" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered when any destination queue has room." + }, + "triggerWhenEmpty" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered when incoming queues are empty." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "useCases" : { + "type" : "array", + "description" : "A list of use cases that have been documented for this Processor", + "items" : { + "$ref" : "#/components/schemas/UseCase" + } + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + }, + "writesAttributes" : { + "type" : "array", + "description" : "The FlowFile attributes this processor writes/updates", + "items" : { + "$ref" : "#/components/schemas/Attribute" + } + } + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ProcessorDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "physicalState" : { + "type" : "string", + "description" : "The physical state of the processor, including transition states", + "enum" : [ "RUNNING", "STOPPED", "DISABLED", "STARTING", "STOPPING", "RUN_ONCE" ] + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/ProcessorStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusDetailsDTO" : { + "type" : "object", + "description" : "The details of a Processor's run status", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The current number of threads that the processor is currently using" + }, + "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", + "items" : { + "type" : "string", + "description" : "The processor's validation errors" + }, + "uniqueItems" : true + } + } + }, + "ProcessorRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "runStatusDetails" : { + "$ref" : "#/components/schemas/ProcessorRunStatusDetailsDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ProcessorStatusSnapshotDTO" + }, + "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" + }, + "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" : "#/components/schemas/NodeProcessorStatusSnapshotDTO" + } + }, + "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" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "processorStatus" : { + "$ref" : "#/components/schemas/ProcessorStatusDTO" + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "description" : "The processor status snapshot from the node.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted 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" + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 minutes" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number 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" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "input" : { + "type" : "string", + "description" : "The count/size of FlowFiles that have been accepted in the last 5 minutes." + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "output" : { + "type" : "string", + "description" : "The count/size of FlowFiles that have been processed in the last 5 minutes." + }, + "processingPerformanceStatus" : { + "$ref" : "#/components/schemas/ProcessingPerformanceStatusDTO" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run 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." + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "description" : "The status of all processors in the process group.", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/components/schemas/ProcessorStatusSnapshotDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessorEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "ProcessorsRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "runStatusDetails" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessorRunStatusDetailsEntity" + } + } + }, + "xml" : { + "name" : "processorsRunStatusDetails" + } + }, + "PropertyAllowableValue" : { + "type" : "object", + "description" : "The allowable values for this property", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the value, e.g., the behavior it produces." + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the value, if different from the internal value" + }, + "value" : { + "type" : "string", + "description" : "The internal value" + } + } + }, + "PropertyDependency" : { + "type" : "object", + "description" : "The dependencies that this property has on other properties", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values that satisfy the dependency", + "items" : { + "type" : "string", + "description" : "The values that satisfy the dependency" + } + }, + "propertyDisplayName" : { + "type" : "string", + "description" : "The name of the property that is depended upon" + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property that is depended upon" + } + } + }, + "PropertyDependencyDTO" : { + "type" : "object", + "description" : "A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values for the property that satisfies the dependency, or null if the dependency is satisfied by the presence of any value for the associated property name", + "items" : { + "type" : "string", + "description" : "The values for the property that satisfies the dependency, or null if the dependency is satisfied by the presence of any value for the associated property name" + }, + "uniqueItems" : true + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property that is being depended upon" + } + } + }, + "PropertyDescriptor" : { + "type" : "object", + "description" : "Descriptions of configuration properties applicable to this component.", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "A list of the allowable values for the property", + "items" : { + "$ref" : "#/components/schemas/PropertyAllowableValue" + } + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value if a user-set value is not specified" + }, + "dependencies" : { + "type" : "array", + "description" : "The dependencies that this property has on other properties", + "items" : { + "$ref" : "#/components/schemas/PropertyDependency" + } + }, + "description" : { + "type" : "string", + "description" : "The description of what the property does" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property key, if different from the name" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the descriptor is for a dynamically added property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language supported by this property", + "enum" : [ "NONE", "ENVIRONMENT", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageScopeDescription" : { + "type" : "string", + "description" : "The description of the expression language scope supported by this property", + "readOnly" : true + }, + "listenPortDefinition" : { + "$ref" : "#/components/schemas/PropertyListenPortDefinition" + }, + "name" : { + "type" : "string", + "description" : "The name of the property key" + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required for the component" + }, + "resourceDefinition" : { + "$ref" : "#/components/schemas/PropertyResourceDefinition" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" + }, + "typeProvidedByValue" : { + "$ref" : "#/components/schemas/DefinedType" + }, + "validRegex" : { + "type" : "string", + "description" : "A regular expression that can be used to validate the value of this property" + }, + "validator" : { + "type" : "string", + "description" : "Name of the validator used for this property descriptor" + } + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/components/schemas/AllowableValueEntity" + } + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "dependencies" : { + "type" : "array", + "description" : "A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.", + "items" : { + "$ref" : "#/components/schemas/PropertyDependencyDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "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" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyGroupConfigurationDTO" : { + "type" : "object", + "description" : "The list of property group configurations for this configuration step.", + "properties" : { + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ConnectorPropertyDescriptorDTO" + }, + "description" : "The property descriptors for this property group, keyed by property name." + }, + "propertyGroupDescription" : { + "type" : "string", + "description" : "The description of the property group." + }, + "propertyGroupName" : { + "type" : "string", + "description" : "The name of the property group." + }, + "propertyValues" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ConnectorValueReferenceDTO" + }, + "description" : "The property values for this property group." + } + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/components/schemas/PreviousValueDTO" + } + } + } + }, + "PropertyListenPortDefinition" : { + "type" : "object", + "description" : "Indicates that this property defines a listen port", + "properties" : { + "applicationProtocols" : { + "type" : "array", + "description" : "The application protocols that this listen port could support (if any)", + "items" : { + "type" : "string", + "description" : "The application protocols that this listen port could support (if any)" + } + }, + "transportProtocol" : { + "type" : "string", + "description" : "The transport protocol used by this listen port", + "enum" : [ "TCP", "UDP" ] + } + } + }, + "PropertyResourceDefinition" : { + "type" : "object", + "description" : "Indicates that this property references external resources", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource definition (i.e. single or multiple)", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resources that can be referenced", + "items" : { + "type" : "string", + "description" : "The types of resources that can be referenced", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + }, + "uniqueItems" : true + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "request" : { + "$ref" : "#/components/schemas/ProvenanceRequestDTO" + }, + "results" : { + "$ref" : "#/components/schemas/ProvenanceResultsDTO" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/components/schemas/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "description" : "The provenance events that matched the search criteria.", + "properties" : { + "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" : "#/components/schemas/AttributeDTO" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string", + "description" : "The child uuids for the event." + } + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "connectorId" : { + "type" : "string", + "description" : "The id of the connector that manages the component that generated the event. If the component is not managed by a connector, this will not be set." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number that's unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventTimestamp" : { + "type" : "string", + "description" : "Event Timestamp formatted using ISO8601" + }, + "eventType" : { + "type" : "string", + "description" : "The type of 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." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "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." + }, + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "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." + }, + "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." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "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." + }, + "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." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string", + "description" : "The parent uuids for the event." + } + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "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 generate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/components/schemas/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "description" : "The links between the nodes in the lineage.", + "properties" : { + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + }, + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "description" : "The nodes in the lineage.", + "properties" : { + "childUuids" : { + "type" : "array", + "description" : "The uuid of the children FlowFiles of the provenance event.", + "items" : { + "type" : "string", + "description" : "The uuid of the children FlowFiles of the provenance event." + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "componentType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of the component that generated the event." + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent FlowFiles of the provenance event.", + "items" : { + "type" : "string", + "description" : "The uuid of the parent FlowFiles of the provenance event." + } + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/components/schemas/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/components/schemas/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "description" : "The provenance request.", + "properties" : { + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "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." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "searchTerms" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ProvenanceSearchValueDTO" + }, + "description" : "The search terms used to perform the search." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "description" : "The provenance results.", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "items" : { + "type" : "string", + "description" : "Any errors that occurred while performing the provenance request." + }, + "uniqueItems" : true + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/components/schemas/ProvenanceEventDTO" + } + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + } + } + }, + "ProvenanceSearchValueDTO" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "properties" : { + "inverse" : { + "type" : "boolean", + "description" : "Query for all except for search value." + }, + "value" : { + "type" : "string", + "description" : "The search value." + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "description" : "The available searchable field for the NiFi.", + "properties" : { + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "id" : { + "type" : "string", + "description" : "The id of 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", + "description" : "The size of the queue", + "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." + } + } + }, + "RebaseAnalysisEntity" : { + "type" : "object", + "properties" : { + "analysisFingerprint" : { + "type" : "string", + "description" : "A fingerprint representing the state of this analysis, used to verify the analysis is still valid when executing the rebase" + }, + "currentVersion" : { + "type" : "string", + "description" : "The current version of the flow in the Process Group" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason the rebase is not allowed, or null if the rebase is allowed" + }, + "localChanges" : { + "type" : "array", + "description" : "The list of local changes that were made to the flow since the last version control operation", + "items" : { + "$ref" : "#/components/schemas/RebaseChangeDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group being rebased" + }, + "rebaseAllowed" : { + "type" : "boolean", + "description" : "Whether the rebase is allowed based on the analysis of local and upstream changes" + }, + "targetVersion" : { + "type" : "string", + "description" : "The target version to rebase to" + }, + "upstreamChanges" : { + "type" : "array", + "description" : "The set of upstream changes between the current version and the target version in the flow registry", + "items" : { + "$ref" : "#/components/schemas/ComponentDifferenceDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "rebaseAnalysisEntity" + } + }, + "RebaseChangeDTO" : { + "type" : "object", + "description" : "The list of local changes that were made to the flow since the last version control operation", + "properties" : { + "classification" : { + "type" : "string", + "description" : "The classification of this change: COMPATIBLE, CONFLICTING, or UNSUPPORTED" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component that was changed" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that was changed" + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that was changed" + }, + "conflictCode" : { + "type" : "string", + "description" : "A code identifying the type of conflict, or null if the change is not conflicting" + }, + "conflictDetail" : { + "type" : "string", + "description" : "A detailed description of the conflict, or null if the change is not conflicting" + }, + "differenceType" : { + "type" : "string", + "description" : "The type of difference detected for this change" + }, + "fieldName" : { + "type" : "string", + "description" : "The name of the field that was changed, or null if not applicable" + }, + "localValue" : { + "type" : "string", + "description" : "The local value of the field, or null if not applicable" + }, + "registryValue" : { + "type" : "string", + "description" : "The registry value of the field, or null if not applicable" + } + } + }, + "RebaseRequestEntity" : { + "type" : "object", + "properties" : { + "analysisFingerprint" : { + "type" : "string", + "description" : "The fingerprint of the rebase analysis, used to verify the analysis is still valid when executing the rebase" + }, + "versionControlInformationEntity" : { + "$ref" : "#/components/schemas/VersionControlInformationEntity" + } + }, + "xml" : { + "name" : "rebaseRequestEntity" + } + }, + "RegisteredFlow" : { + "type" : "object", + "properties" : { + "branch" : { + "type" : "string" + }, + "bucketIdentifier" : { + "type" : "string" + }, + "bucketName" : { + "type" : "string" + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "description" : { + "type" : "string" + }, + "identifier" : { + "type" : "string" + }, + "lastModifiedTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + }, + "permissions" : { + "$ref" : "#/components/schemas/FlowRegistryPermissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64" + }, + "versionInfo" : { + "$ref" : "#/components/schemas/RegisteredFlowVersionInfo" + } + } + }, + "RegisteredFlowSnapshot" : { + "type" : "object", + "properties" : { + "bucket" : { + "$ref" : "#/components/schemas/FlowRegistryBucket" + }, + "externalControllerServices" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ExternalControllerServiceReference" + } + }, + "flow" : { + "$ref" : "#/components/schemas/RegisteredFlow" + }, + "flowContents" : { + "$ref" : "#/components/schemas/VersionedProcessGroup" + }, + "flowEncodingVersion" : { + "type" : "string" + }, + "latest" : { + "type" : "boolean" + }, + "parameterContexts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedParameterContext" + } + }, + "parameterProviders" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ParameterProviderReference" + } + }, + "snapshotMetadata" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshotMetadata" + } + } + }, + "RegisteredFlowSnapshotMetadata" : { + "type" : "object", + "properties" : { + "author" : { + "type" : "string" + }, + "branch" : { + "type" : "string" + }, + "bucketIdentifier" : { + "type" : "string" + }, + "comments" : { + "type" : "string" + }, + "flowIdentifier" : { + "type" : "string" + }, + "flowName" : { + "type" : "string" + }, + "registryIdentifier" : { + "type" : "string" + }, + "registryName" : { + "type" : "string" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64" + }, + "version" : { + "type" : "string" + } + } + }, + "RegisteredFlowVersionInfo" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "Relationship" : { + "type" : "object", + "description" : "The supported relationships for this processor.", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the relationship" + }, + "name" : { + "type" : "string", + "description" : "The name of the relationship" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "description" : "The available relationships that the processor currently supports.", + "properties" : { + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not FlowFiles sent to this relationship should auto terminate." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "retry" : { + "type" : "boolean", + "description" : "Whether or not FlowFiles sent to this relationship should retry." + } + }, + "readOnly" : true + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupPortDTO" + }, + "uniqueItems" : true + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupPortDTO" + }, + "uniqueItems" : true + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string", + "description" : "Any remote authorization issues for 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." + }, + "contents" : { + "$ref" : "#/components/schemas/RemoteProcessGroupContentsDTO" + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "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." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "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." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "transportProtocol" : { + "type" : "string" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the remote process group.\nThese validation errors represent the problems with the remote process group that must be resolved before it can transmit.\n", + "items" : { + "type" : "string", + "description" : "The validation errors for the remote process group.\nThese validation errors represent the problems with the remote process group that must be resolved before it can transmit.\n" + } + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/RemoteProcessGroupDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "description" : "The output ports from which data can be retrieved.", + "properties" : { + "batchSettings" : { + "$ref" : "#/components/schemas/BatchSettingsDTO" + }, + "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." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "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." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "remoteProcessGroupPort" : { + "$ref" : "#/components/schemas/RemoteProcessGroupPortDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "description" : "The status of the remote process group.", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusSnapshotDTO" + }, + "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." + }, + "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" : "#/components/schemas/NodeRemoteProcessGroupStatusSnapshotDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "remoteProcessGroupStatus" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "description" : "The remote process group status snapshot from the node.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from 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." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the FlowFiles received from 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." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "description" : "The status of all remote process groups in the process group.", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/components/schemas/RemoteProcessGroupStatusSnapshotDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RemoteProcessGroupEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "ReplayLastEventRequestEntity" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The UUID of the component whose last event should be replayed." + }, + "nodes" : { + "type" : "string", + "description" : "Which nodes are to replay their last provenance event.", + "enum" : [ "ALL", "PRIMARY" ] + } + }, + "xml" : { + "name" : "replayLastEventRequestEntity" + } + }, + "ReplayLastEventResponseEntity" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/ReplayLastEventSnapshotDTO" + }, + "componentId" : { + "type" : "string", + "description" : "The UUID of the component whose last event should be replayed." + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "The node-wise results", + "items" : { + "$ref" : "#/components/schemas/NodeReplayLastEventSnapshotDTO" + } + }, + "nodes" : { + "type" : "string", + "description" : "Which nodes were requested to replay their last provenance event.", + "enum" : [ "ALL", "PRIMARY" ] + } + }, + "xml" : { + "name" : "replayLastEventResponseEntity" + } + }, + "ReplayLastEventSnapshotDTO" : { + "type" : "object", + "description" : "The snapshot from the node", + "properties" : { + "eventAvailable" : { + "type" : "boolean", + "description" : "Whether or not an event was available. This may not be populated if there was a failure." + }, + "eventsReplayed" : { + "type" : "array", + "description" : "The IDs of the events that were successfully replayed", + "items" : { + "type" : "integer", + "format" : "int64", + "description" : "The IDs of the events that were successfully replayed" + } + }, + "failureExplanation" : { + "type" : "string", + "description" : "If unable to replay an event, specifies why the event could not be replayed" + } + }, + "xml" : { + "name" : "replayLastEventSnapshot" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the reporting task. This is how the custom UI relays configuration to the reporting task." + }, + "bundle" : { + "$ref" : "#/components/schemas/BundleDTO" + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The default scheduling period for the different scheduling strategies." + }, + "description" : "The default scheduling period for the different scheduling strategies." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "descriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptorDTO" + }, + "description" : "The descriptors for the reporting tasks properties." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties of the reporting task." + }, + "description" : "The properties of the reporting task." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value will depend on the value of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "items" : { + "type" : "string", + "description" : "Set of sensitive dynamic property names" + }, + "uniqueItems" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the reporting task supports sensitive dynamic properties." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of 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", + "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." + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Reporting Task is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Reporting Task is valid)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "ReportingTaskDefinition" : { + "type" : "object", + "description" : "Reporting Tasks provided in this bundle", + "properties" : { + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "defaultSchedulingPeriodBySchedulingStrategy" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\"." + }, + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\"." + }, + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The default scheduling strategy for the reporting task." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "items" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field provides alternatives to use" + }, + "uniqueItems" : true + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + } + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "uniqueItems" : true + }, + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/PropertyDescriptor" + }, + "description" : "Descriptions of configuration properties applicable to this component." + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/components/schemas/DefinedType" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "items" : { + "type" : "string", + "description" : "The names of other component types that may be related" + }, + "uniqueItems" : true + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportedSchedulingStrategies" : { + "type" : "array", + "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", + "items" : { + "type" : "string", + "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON." + } + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "items" : { + "type" : "string", + "description" : "The tags associated with this type" + }, + "uniqueItems" : true + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/ReportingTaskDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "operatePermissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "status" : { + "$ref" : "#/components/schemas/ReportingTaskStatusDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "description" : "The status for this ReportingTask.", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ], + "readOnly" : true + }, + "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)", + "enum" : [ "VALID", "INVALID", "VALIDATING" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DocumentedTypeDTO" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "reportingTasks" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ReportingTaskEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "description" : "The required permission necessary for this restriction.", + "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." + } + } + }, + "ResourceClaimDetailsDTO" : { + "type" : "object", + "properties" : { + "awaitingDestruction" : { + "type" : "boolean", + "description" : "Whether or not the Resource Claim is awaiting destruction" + }, + "claimantCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have a claim to the Resource" + }, + "container" : { + "type" : "string", + "description" : "The container of the Content Repository in which the Resource Claim exists" + }, + "identifier" : { + "type" : "string", + "description" : "The identifier of the Resource Claim" + }, + "inUse" : { + "type" : "boolean", + "description" : "Whether or not the Resource Claim is in use" + }, + "section" : { + "type" : "string", + "description" : "The section of the Content Repository in which the Resource Claim exists" + }, + "writable" : { + "type" : "boolean", + "description" : "Whether or not the Resource Claim can still have more data written to it" + } + } + }, + "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" : "#/components/schemas/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "Restriction" : { + "type" : "object", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "properties" : { + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction" + }, + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + } + } + }, + "RevisionDTO" : { + "type" : "object", + "description" : "The revision of the Process Group", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "A client identifier used to make a request.\nBy including a client identifier, the API can allow multiple requests without needing the current revision.\nDue 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\n" + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + }, + "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.\nIn a response to a mutable flow request, this field represents the updated base version.\n" + } + } + }, + "RunStatusDetailsRequestEntity" : { + "type" : "object", + "properties" : { + "processorIds" : { + "type" : "array", + "description" : "The IDs of all processors whose run status details should be provided", + "items" : { + "type" : "string", + "description" : "The IDs of all processors whose run status details should be provided" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "runStatusDetailsRequest" + } + }, + "RuntimeManifest" : { + "type" : "object", + "properties" : { + "agentType" : { + "type" : "string", + "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "bundles" : { + "type" : "array", + "description" : "All extension bundles included with this runtime", + "items" : { + "$ref" : "#/components/schemas/Bundle" + } + }, + "identifier" : { + "type" : "string", + "description" : "A unique identifier for the manifest" + }, + "schedulingDefaults" : { + "$ref" : "#/components/schemas/SchedulingDefaults" + }, + "version" : { + "type" : "string", + "description" : "The version of the runtime binary, e.g., '1.0.1'" + } + } + }, + "RuntimeManifestEntity" : { + "type" : "object", + "properties" : { + "runtimeManifest" : { + "$ref" : "#/components/schemas/RuntimeManifest" + } + }, + "xml" : { + "name" : "runtimeManifestEntity" + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "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" ] + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SchedulingDefaults" : { + "type" : "object", + "description" : "Scheduling defaults for components defined in this manifest", + "properties" : { + "defaultConcurrentTasksBySchedulingStrategy" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The default concurrent tasks for each scheduling strategy" + }, + "description" : "The default concurrent tasks for each scheduling strategy" + }, + "defaultMaxConcurrentTasks" : { + "type" : "string", + "description" : "The default concurrent tasks" + }, + "defaultRunDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The default run duration in nano-seconds" + }, + "defaultSchedulingPeriodMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default scheduling period in milliseconds" + }, + "defaultSchedulingPeriodsBySchedulingStrategy" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The default scheduling period for each scheduling strategy" + }, + "description" : "The default scheduling period for each scheduling strategy" + }, + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The name of the default scheduling strategy", + "enum" : [ "TIMER_DRIVEN", "CRON_DRIVEN" ] + }, + "penalizationPeriodMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default penalization period in milliseconds" + }, + "yieldDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default yield duration in milliseconds" + } + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + }, + "required" : [ "id" ] + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "controllerServiceNodeResults" : { + "type" : "array", + "description" : "The controller service nodes that matched the search", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "labelResults" : { + "type" : "array", + "description" : "The labels that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "parameterProviderNodeResults" : { + "type" : "array", + "description" : "The parameter provider nodes that matched the search", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/components/schemas/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/components/schemas/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SecretDTO" : { + "type" : "object", + "description" : "The list of secrets available from all secret providers.", + "properties" : { + "description" : { + "type" : "string", + "description" : "A description of the secret." + }, + "fullyQualifiedName" : { + "type" : "string", + "description" : "The fully qualified name of the secret, including the group name." + }, + "groupName" : { + "type" : "string", + "description" : "The name of the group this secret belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the secret." + }, + "providerId" : { + "type" : "string", + "description" : "The identifier of the secret provider that manages this secret." + }, + "providerName" : { + "type" : "string", + "description" : "The name of the secret provider that manages this secret." + } + } + }, + "SecretsEntity" : { + "type" : "object", + "properties" : { + "secrets" : { + "type" : "array", + "description" : "The list of secrets available from all secret providers.", + "items" : { + "$ref" : "#/components/schemas/SecretDTO" + } + } + }, + "xml" : { + "name" : "secretsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "description" : "The snippet.", + "properties" : { + "connections" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "funnels" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "inputPorts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "labels" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "outputPorts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "processors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "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)." + }, + "remoteProcessGroups" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "description" : "The ids of the remote process groups in this snippet.\nThese ids will be populated within each response.\nThey can be specified when creating a snippet.\nHowever, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).\n" + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "snippet" : { + "$ref" : "#/components/schemas/SnippetDTO" + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "versionedFlow" : { + "$ref" : "#/components/schemas/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "description" : "The state.", + "properties" : { + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "description" : "The local state for this component.", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/components/schemas/StateEntryDTO" + } + }, + "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." + } + } + }, + "Stateful" : { + "type" : "object", + "description" : "Indicates if the component stores state", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description of what information is being stored in the StateManager" + }, + "scopes" : { + "type" : "array", + "description" : "Indicates the Scope(s) associated with the State that is stored and retrieved", + "items" : { + "type" : "string", + "description" : "Indicates the Scope(s) associated with the State that is stored and retrieved", + "enum" : [ "CLUSTER", "LOCAL" ] + }, + "uniqueItems" : true + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "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" : "#/components/schemas/StatusSnapshotDTO" + } + }, + "componentDetails" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to" + }, + "description" : "A Map of key/value pairs that describe the component that the status history belongs to" + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/components/schemas/StatusDescriptorDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "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" : "#/components/schemas/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "statusHistory" : { + "$ref" : "#/components/schemas/StatusHistoryDTO" + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "properties" : { + "statusMetrics" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int64", + "description" : "The status metrics." + }, + "description" : "The status metrics." + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + } + } + }, + "StepDocumentationEntity" : { + "type" : "object", + "properties" : { + "stepDocumentation" : { + "type" : "string" + } + }, + "xml" : { + "name" : "stepDocumentationEntity" + } + }, + "StorageUsageDTO" : { + "type" : "object", + "description" : "The provenance repository storage usage.", + "properties" : { + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used 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" : { + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SupportedMimeTypesDTO" : { + "type" : "object", + "description" : "The mime types this Content Viewer supports.", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "The display name of the mime types.", + "readOnly" : true + }, + "mimeTypes" : { + "type" : "array", + "description" : "The mime types this Content Viewer supports.", + "items" : { + "type" : "string", + "description" : "The mime types this Content Viewer supports.", + "readOnly" : true + }, + "readOnly" : true + } + }, + "readOnly" : true + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "$ref" : "#/components/schemas/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" : "#/components/schemas/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/components/schemas/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "description" : "The System Diagnostics snapshot from the node.", + "properties" : { + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "items" : { + "$ref" : "#/components/schemas/StorageUsageDTO" + }, + "uniqueItems" : true + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "flowFileRepositoryStorageUsage" : { + "$ref" : "#/components/schemas/StorageUsageDTO" + }, + "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" + }, + "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" + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "items" : { + "$ref" : "#/components/schemas/GarbageCollectionDTO" + }, + "uniqueItems" : true + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "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" + }, + "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." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "items" : { + "$ref" : "#/components/schemas/StorageUsageDTO" + }, + "uniqueItems" : true + }, + "resourceClaimDetails" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ResourceClaimDetailsDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "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" + }, + "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" + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "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" + }, + "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" + }, + "versionInfo" : { + "$ref" : "#/components/schemas/VersionInfoDTO" + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "description" : "The system resource considerations for the given component", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + }, + "resource" : { + "type" : "string", + "description" : "The resource to consider" + } + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "TenantEntity" : { + "type" : "object", + "description" : "The set of user group IDs associated with this access policy.", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/TenantDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + } + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "referencingComponentRevisions" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "description" : "The revisions for all referencing components." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "uiOnly" : { + "type" : "boolean", + "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface.\nAs such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice.\nAs a result, this value should not be set to true by any client other than the UI.\n" + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UseCase" : { + "type" : "object", + "description" : "A list of use cases that have been documented for this Processor", + "properties" : { + "configuration" : { + "type" : "string", + "description" : "A description of how to configure the Processor to perform the task described in the use case" + }, + "description" : { + "type" : "string", + "description" : "A description of the use case" + }, + "inputRequirement" : { + "type" : "string", + "description" : "Specifies whether an incoming FlowFile is expected for this use case", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "keywords" : { + "type" : "array", + "description" : "Keywords that pertain to the use case", + "items" : { + "type" : "string", + "description" : "Keywords that pertain to the use case" + } + }, + "notes" : { + "type" : "string", + "description" : "Any pertinent notes about the use case" + } + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "items" : { + "$ref" : "#/components/schemas/AccessPolicySummaryEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/UserDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "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.", + "items" : { + "$ref" : "#/components/schemas/AccessPolicyEntity" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "items" : { + "$ref" : "#/components/schemas/TenantEntity" + }, + "uniqueItems" : true + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/components/schemas/BulletinEntity" + } + }, + "component" : { + "$ref" : "#/components/schemas/UserGroupDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "$ref" : "#/components/schemas/PermissionsDTO" + }, + "position" : { + "$ref" : "#/components/schemas/PositionDTO" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VerifyConfigRequestDTO" : { + "type" : "object", + "description" : "The request", + "properties" : { + "attributes" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values" + }, + "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values" + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component whose configuration was verified" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "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 + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The configured component properties" + }, + "description" : "The configured component properties" + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "The Results of the verification", + "items" : { + "$ref" : "#/components/schemas/ConfigVerificationResultDTO" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/VerifyConfigUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "VerifyConfigRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "$ref" : "#/components/schemas/VerifyConfigRequestDTO" + } + }, + "xml" : { + "name" : "verifyConfigRequest" + } + }, + "VerifyConfigUpdateStepDTO" : { + "type" : "object", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + }, + "readOnly" : true + }, + "VerifyConnectorConfigStepRequestDTO" : { + "type" : "object", + "description" : "The verification request", + "properties" : { + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "configurationStep" : { + "$ref" : "#/components/schemas/ConfigurationStepConfigurationDTO" + }, + "configurationStepName" : { + "type" : "string", + "description" : "The name of the configuration step being verified" + }, + "connectorId" : { + "type" : "string", + "description" : "The ID of the connector whose configuration step is being verified" + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "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 + }, + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "The results of the verification", + "items" : { + "$ref" : "#/components/schemas/ConfigVerificationResultDTO" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "items" : { + "$ref" : "#/components/schemas/VerifyConfigUpdateStepDTO" + }, + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + } + } + }, + "VerifyConnectorConfigStepRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "$ref" : "#/components/schemas/VerifyConnectorConfigStepRequestDTO" + } + }, + "xml" : { + "name" : "verifyConnectorConfigStepRequestEntity" + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "versionControlComponentMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The mapping of Versioned Component Identifiers to instance ID's" + }, + "description" : "The mapping of Versioned Component Identifiers to instance ID's" + }, + "versionControlInformation" : { + "$ref" : "#/components/schemas/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "description" : "The Version Control information", + "properties" : { + "branch" : { + "type" : "string", + "description" : "The ID of the branch that the flow is stored in" + }, + "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 + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "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 + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ], + "readOnly" : true + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + }, + "storageLocation" : { + "type" : "string", + "description" : "The storage location" + }, + "version" : { + "type" : "string", + "description" : "The version of the flow" + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "versionControlInformation" : { + "$ref" : "#/components/schemas/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "description" : "The nifi, os, java, and build version information", + "properties" : { + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + } + } + }, + "VersionedAsset" : { + "type" : "object", + "description" : "The assets that are referenced by this parameter", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the asset" + }, + "name" : { + "type" : "string", + "description" : "The name of the asset" + } + } + }, + "VersionedComponentState" : { + "type" : "object", + "description" : "The state of the component, if exported with state", + "properties" : { + "clusterState" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The cluster-scoped state of the component, or null if not exported" + }, + "description" : "The cluster-scoped state of the component, or null if not exported" + }, + "localNodeStates" : { + "type" : "array", + "description" : "The local-scoped state of the component ordered by node ordinal index, or null if not exported", + "items" : { + "$ref" : "#/components/schemas/VersionedNodeState" + } + } + } + }, + "VersionedConnection" : { + "type" : "object", + "description" : "The Connections", + "properties" : { + "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." + }, + "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." + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/components/schemas/Position" + } + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "destination" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "The amount of time a FlowFile may be in the flow before it will be automatically aged out of the flow. Once a FlowFile reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details." + }, + "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. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "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." + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string", + "description" : "The comparators used to prioritize the queue." + } + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "items" : { + "type" : "string", + "description" : "The selected relationship that comprise the connection." + }, + "uniqueItems" : true + }, + "source" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "description" : "The Controller Services", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "componentState" : { + "$ref" : "#/components/schemas/VersionedComponentState" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceAPI" + } + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedPropertyDescriptor" + }, + "description" : "The property descriptors for the component." + }, + "scheduledState" : { + "type" : "string", + "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "properties" : { + "branch" : { + "type" : "string", + "description" : "The name of the branch that the flow resides in" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + }, + "registryId" : { + "type" : "string", + "description" : "The identifier of the Flow Registry that contains the flow" + }, + "storageLocation" : { + "type" : "string", + "description" : "The location of the Flow Registry that stores the flow" + }, + "version" : { + "type" : "string", + "description" : "The version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "description" : "The versioned flow", + "properties" : { + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + }, + "branch" : { + "type" : "string", + "description" : "The branch where the flow is stored" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "$ref" : "#/components/schemas/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowMigrationSourceDTO" : { + "type" : "object", + "description" : "The Versioned Process Groups that the Connector can be migrated from.", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The Flow Registry bucket identifier for the source Process Group." + }, + "flowId" : { + "type" : "string", + "description" : "The Flow Registry flow identifier for the source Process Group." + }, + "flowName" : { + "type" : "string", + "description" : "The name of the versioned flow backing the source Process Group, as recorded in the Flow Registry. May be null when the registry has not yet supplied a name (for example, while the source's version control state is SYNC_FAILURE)." + }, + "ineligibilityReasons" : { + "type" : "array", + "description" : "User-facing descriptions of all conditions that currently prevent the source Process Group from being migrated. Empty when readyForMigration is true. Each entry describes a single remediable condition (running processors, queued FlowFiles, etc.); every applicable condition is included so the user can address them together.", + "items" : { + "type" : "string", + "description" : "User-facing descriptions of all conditions that currently prevent the source Process Group from being migrated. Empty when readyForMigration is true. Each entry describes a single remediable condition (running processors, queued FlowFiles, etc.); every applicable condition is included so the user can address them together." + } + }, + "parentProcessGroupId" : { + "type" : "string", + "description" : "The identifier of the parent Process Group of the source Process Group." + }, + "processGroupId" : { + "type" : "string", + "description" : "The identifier of the source Process Group." + }, + "processGroupName" : { + "type" : "string", + "description" : "The name of the source Process Group." + }, + "readyForMigration" : { + "type" : "boolean", + "description" : "Whether the source Process Group is currently in a state that allows it to be migrated into the target Connector. When false, ineligibilityReasons describes what must change before the migration can proceed." + }, + "registryClientId" : { + "type" : "string", + "description" : "The identifier of the Flow Registry client backing the source Process Group." + }, + "version" : { + "type" : "string", + "description" : "The published version of the source Process Group." + } + } + }, + "VersionedFlowMigrationSourcesEntity" : { + "type" : "object", + "properties" : { + "migrationSources" : { + "type" : "array", + "description" : "The Versioned Process Groups that the Connector can be migrated from.", + "items" : { + "$ref" : "#/components/schemas/VersionedFlowMigrationSourceDTO" + } + } + }, + "xml" : { + "name" : "versionedFlowMigrationSourcesEntity" + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "processGroupRevision" : { + "$ref" : "#/components/schemas/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." + }, + "versionedFlow" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + }, + "versionedFlowSnapshot" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshot" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "versionedFlowSnapshotMetadata" : { + "$ref" : "#/components/schemas/RegisteredFlowSnapshotMetadata" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshotMetadataEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "description" : "The Flow Update Request", + "properties" : { + "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 + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "versionControlInformation" : { + "$ref" : "#/components/schemas/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "$ref" : "#/components/schemas/RevisionDTO" + }, + "request" : { + "$ref" : "#/components/schemas/VersionedFlowUpdateRequestDTO" + } + }, + "xml" : { + "name" : "registeredFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/VersionedFlowEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "description" : "The Funnels", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "description" : "The Labels", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + } + } + }, + "VersionedListenPortDefinition" : { + "type" : "object", + "description" : "Returns the Listen Port Definition for the port this property specifies, if applicable", + "properties" : { + "applicationProtocols" : { + "type" : "array", + "description" : "The application protocol(s) that the listen port could support (if any)", + "items" : { + "type" : "string", + "description" : "The application protocol(s) that the listen port could support (if any)" + } + }, + "transportProtocol" : { + "type" : "string", + "description" : "The transport protocol used by the listen port", + "enum" : [ "TCP", "UDP" ] + } + } + }, + "VersionedNodeState" : { + "type" : "object", + "description" : "The state entries for a single node", + "properties" : { + "state" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The state key-value pairs for this node" + }, + "description" : "The state key-value pairs for this node" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "description" : "The parameters in the context", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is provided by a ParameterProvider" + }, + "referencedAssets" : { + "type" : "array", + "description" : "The assets that are referenced by this parameter", + "items" : { + "$ref" : "#/components/schemas/VersionedAsset" + } + }, + "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" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "The names of additional parameter contexts from which to inherit parameters", + "items" : { + "type" : "string", + "description" : "The names of additional parameter contexts from which to inherit parameters" + } + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "parameterGroupName" : { + "type" : "string", + "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" + }, + "parameterProvider" : { + "type" : "string", + "description" : "The identifier of an optional parameter provider" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "items" : { + "$ref" : "#/components/schemas/VersionedParameter" + }, + "uniqueItems" : true + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" + } + } + }, + "VersionedPort" : { + "type" : "object", + "description" : "The Output Ports", + "properties" : { + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "portFunction" : { + "type" : "string", + "description" : "Specifies how the Port should function", + "enum" : [ "STANDARD", "FAILURE" ] + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "items" : { + "$ref" : "#/components/schemas/VersionedConnection" + }, + "uniqueItems" : true + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "items" : { + "$ref" : "#/components/schemas/VersionedControllerService" + }, + "uniqueItems" : true + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "executionEngine" : { + "type" : "string", + "description" : "The Execution Engine that should be used to run the components within the group.", + "enum" : [ "STANDARD", "STATELESS", "INHERITED" ] + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "items" : { + "$ref" : "#/components/schemas/VersionedFunnel" + }, + "uniqueItems" : true + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "items" : { + "$ref" : "#/components/schemas/VersionedLabel" + }, + "uniqueItems" : true + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "maxConcurrentTasks" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessGroup" + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessor" + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteProcessGroup" + }, + "uniqueItems" : true + }, + "scheduledState" : { + "type" : "string", + "description" : "The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "statelessFlowTimeout" : { + "type" : "string", + "description" : "The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure" + }, + "versionedFlowCoordinates" : { + "$ref" : "#/components/schemas/VersionedFlowCoordinates" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "description" : "The Processors", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the processor." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "The names of all relationships that cause a FlowFile 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.", + "items" : { + "type" : "string", + "description" : "The names of all relationships that cause a FlowFile 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 + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "componentState" : { + "$ref" : "#/components/schemas/VersionedComponentState" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a FlowFile." + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedPropertyDescriptor" + }, + "description" : "The property descriptors for the component." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "items" : { + "type" : "string", + "description" : "All the relationships should be retried." + }, + "uniqueItems" : true + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "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" : "Indicates how the processor should be scheduled to run." + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Stylistic data for rendering in a UI" + }, + "description" : "Stylistic data for rendering in a UI" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the property is user-defined" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "listenPortDefinition" : { + "$ref" : "#/components/schemas/VersionedListenPortDefinition" + }, + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "resourceDefinition" : { + "$ref" : "#/components/schemas/VersionedResourceDefinition" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "properties" : { + "batchSize" : { + "$ref" : "#/components/schemas/BatchSize" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit FlowFiles to the target port concurrently." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the FlowFiles are compressed when sent to the target port." + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "description" : "The Remote Process Groups", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteGroupPort" + }, + "uniqueItems" : true + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "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." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteGroupPort" + }, + "uniqueItems" : true + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "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." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications. Possible returned values: RAW, HTTP." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + } + } + }, + "VersionedReportingTask" : { + "type" : "object", + "description" : "The reporting tasks", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task." + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "componentState" : { + "$ref" : "#/components/schemas/VersionedComponentState" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedPropertyDescriptor" + }, + "description" : "The property descriptors for the component." + }, + "scheduledState" : { + "type" : "string", + "description" : "Indicates the scheduled state for the Reporting Task", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indicates scheduling strategy that should dictate how the reporting task is triggered." + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + } + } + }, + "VersionedReportingTaskImportRequestEntity" : { + "type" : "object", + "properties" : { + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "The disconnected node acknowledged flag" + }, + "reportingTaskSnapshot" : { + "$ref" : "#/components/schemas/VersionedReportingTaskSnapshot" + } + }, + "xml" : { + "name" : "versionedReportingTaskImportRequestEntity" + } + }, + "VersionedReportingTaskImportResponseEntity" : { + "type" : "object", + "properties" : { + "controllerServices" : { + "type" : "array", + "description" : "The controller services created by the import", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceEntity" + }, + "uniqueItems" : true + }, + "reportingTasks" : { + "type" : "array", + "description" : "The reporting tasks created by the import", + "items" : { + "$ref" : "#/components/schemas/ReportingTaskEntity" + }, + "uniqueItems" : true + } + }, + "xml" : { + "name" : "versionedReportingTaskImportResponseEntity" + } + }, + "VersionedReportingTaskSnapshot" : { + "type" : "object", + "properties" : { + "controllerServices" : { + "type" : "array", + "description" : "The controller services", + "items" : { + "$ref" : "#/components/schemas/VersionedControllerService" + } + }, + "reportingTasks" : { + "type" : "array", + "description" : "The reporting tasks", + "items" : { + "$ref" : "#/components/schemas/VersionedReportingTask" + } + } + } + }, + "VersionedResourceDefinition" : { + "type" : "object", + "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "items" : { + "type" : "string", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + }, + "uniqueItems" : true + } + } + } + }, + "securitySchemes" : { + "CookieSecureAuthorizationBearer" : { + "description" : "JSON Web Token authentication with session cookie", + "in" : "cookie", + "name" : "__Secure-Authorization-Bearer", + "type" : "apiKey" + }, + "HTTPBearerJWT" : { + "bearerFormat" : "JWT", + "description" : "HTTP Bearer authentication with JSON Web Token", + "scheme" : "Bearer", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-2.12.0.json b/resources/client_gen/api_defs/registry-2.12.0.json new file mode 100644 index 00000000..e8903d20 --- /dev/null +++ b/resources/client_gen/api_defs/registry-2.12.0.json @@ -0,0 +1,7484 @@ +{ + "openapi" : "3.0.1", + "info" : { + "contact" : { + "email" : "dev@nifi.apache.org", + "url" : "https://nifi.apache.org" + }, + "description" : "REST API definition for Apache NiFi Registry web services", + "license" : { + "name" : "Apache 2.0", + "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title" : "Apache NiFi Registry REST API", + "version" : "2.12.0" + }, + "paths" : { + "/about" : { + "get" : { + "description" : "Gets the NiFi Registry version.", + "operationId" : "getVersion", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RegistryAbout" + } + } + } + } + }, + "summary" : "Get version", + "tags" : [ "About" ] + } + }, + "/access" : { + "get" : { + "description" : "Returns the current client's authenticated identity and permissions to top-level resources", + "operationId" : "getAccessStatus", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get access status", + "tags" : [ "Access" ] + } + }, + "/access/logout" : { + "delete" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "logout", + "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." + } + }, + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "tags" : [ "Access" ] + } + }, + "/access/logout/complete" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "logoutComplete", + "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." + } + }, + "summary" : "Completes the logout sequence.", + "tags" : [ "Access" ] + } + }, + "/access/oidc/callback" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcCallback", + "responses" : { + "200" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "tags" : [ "Access" ] + } + }, + "/access/oidc/exchange" : { + "post" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcExchange", + "responses" : { + "200" : { + "content" : { + "text/plain" : { } + }, + "description" : "default response" + } + }, + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "tags" : [ "Access" ] + } + }, + "/access/oidc/logout" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcLogout", + "responses" : { + "200" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "summary" : "Performs a logout in the OpenId Provider.", + "tags" : [ "Access" ] + } + }, + "/access/oidc/logout/callback" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcLogoutCallback", + "responses" : { + "200" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", + "tags" : [ "Access" ] + } + }, + "/access/oidc/request" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcRequest", + "responses" : { + "200" : { + "content" : { + "*/*" : { } + }, + "description" : "default response" + } + }, + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "tags" : [ "Access" ] + } + }, + "/access/token" : { + "post" : { + "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", + "responses" : { + "201" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Create token trying all providers", + "tags" : [ "Access" ] + } + }, + "/access/token/identity-provider" : { + "post" : { + "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", + "responses" : { + "201" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Create token using identity provider", + "tags" : [ "Access" ] + } + }, + "/access/token/identity-provider/test" : { + "post" : { + "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", + "responses" : { + "200" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Test identity provider", + "tags" : [ "Access" ] + } + }, + "/access/token/identity-provider/usage" : { + "get" : { + "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", + "operationId" : "getIdentityProviderUsageInstructions", + "responses" : { + "200" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Get identity provider usage", + "tags" : [ "Access" ] + } + }, + "/access/token/kerberos" : { + "post" : { + "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", + "responses" : { + "201" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Create token using kerberos", + "tags" : [ "Access" ] + } + }, + "/access/token/login" : { + "post" : { + "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", + "responses" : { + "201" : { + "content" : { + "text/plain" : { + "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." + } + }, + "summary" : "Create token using basic auth", + "tags" : [ "Access" ] + } + }, + "/buckets" : { + "get" : { + "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", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Bucket" + } + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "summary" : "Get all buckets", + "tags" : [ "Buckets" ] + }, + "post" : { + "operationId" : "createBucket", + "parameters" : [ { + "description" : "Whether source properties like identifier should be kept", + "in" : "query", + "name" : "preserveSourceProperties", + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Bucket" + } + } + }, + "description" : "The bucket to create", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create bucket", + "tags" : [ "Buckets" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets" + } + } + }, + "/buckets/fields" : { + "get" : { + "description" : "Retrieves bucket field names for searching or sorting on buckets.", + "operationId" : "getAvailableBucketFields", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Fields" + } + } + } + } + }, + "summary" : "Get bucket fields", + "tags" : [ "Buckets" ] + } + }, + "/buckets/{bucketId}" : { + "delete" : { + "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", + "operationId" : "deleteBucket", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete bucket", + "tags" : [ "Buckets" ], + "x-access-policy" : { + "action" : "delete", + "resource" : "/buckets/{bucketId}" + } + }, + "get" : { + "description" : "Gets the bucket with the given id.", + "operationId" : "getBucket", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket", + "tags" : [ "Buckets" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + }, + "put" : { + "description" : "Updates the bucket with the given id.", + "operationId" : "updateBucket", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Bucket" + } + } + }, + "description" : "The updated bucket", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Update bucket", + "tags" : [ "Buckets" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/bundles" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionBundles", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Bundle" + } + } + } + } + }, + "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." + } + }, + "summary" : "Get extension bundles by bucket", + "tags" : [ "BucketBundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/bundles/{bundleType}" : { + "post" : { + "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", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The type of the bundle", + "in" : "path", + "name" : "bundleType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + } + } ], + "requestBody" : { + "content" : { + "multipart/form-data" : { + "schema" : { + "type" : "object", + "properties" : { + "file" : { + "$ref" : "#/components/schemas/FormDataContentDisposition" + }, + "sha256" : { + "type" : "string" + } + } + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create extension bundle version", + "tags" : [ "BucketBundles" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows" : { + "get" : { + "description" : "Retrieves all flows in the given bucket.", + "operationId" : "getFlows", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket flows", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + }, + "post" : { + "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", + "operationId" : "createFlow", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlow" + } + } + }, + "description" : "The details of the flow to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create flow", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}" : { + "delete" : { + "description" : "Deletes a flow, including all saved versions of that flow.", + "operationId" : "deleteFlow", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete bucket flow", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "delete", + "resource" : "/buckets/{bucketId}" + } + }, + "get" : { + "description" : "Retrieves the flow with the given id in the given bucket.", + "operationId" : "getFlow", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket flow", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + }, + "put" : { + "description" : "Updates the flow with the given id in the given bucket.", + "operationId" : "updateFlow", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlow" + } + } + }, + "description" : "The updated flow", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Update bucket flow", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { + "get" : { + "description" : "Computes the differences between two given versions of a flow.", + "operationId" : "getFlowDiff", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The first version number", + "in" : "path", + "name" : "versionA", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + }, { + "description" : "The second version number", + "in" : "path", + "name" : "versionB", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket flow diff", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions" : { + "get" : { + "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", + "operationId" : "getFlowVersions", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket flow versions", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + }, + "post" : { + "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", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Whether source properties like author should be kept", + "in" : "query", + "name" : "preserveSourceProperties", + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshot" + } + } + }, + "description" : "The new versioned flow snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create flow version", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/import" : { + "post" : { + "description" : "Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created.", + "operationId" : "importVersionedFlow", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "Comments", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshot" + } + } + }, + "description" : "file" + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshot" + } + } + }, + "description" : "The resource has been successfully created." + }, + "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." + } + }, + "summary" : "Import flow version", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { + "get" : { + "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", + "operationId" : "getLatestFlowVersion", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get latest bucket flow version content", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "getLatestFlowVersionMetadata", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get latest bucket flow version metadata", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "description" : "Gets the given version of a flow, including the metadata and content for the version.", + "operationId" : "getFlowVersion", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version number", + "in" : "path", + "name" : "versionNumber", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket flow version", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { + "get" : { + "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", + "operationId" : "exportVersionedFlow", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version number", + "in" : "path", + "name" : "versionNumber", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Exports specified bucket flow version content", + "tags" : [ "BucketFlows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles" : { + "get" : { + "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", + "parameters" : [ { + "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'.", + "in" : "query", + "name" : "bucketName", + "schema" : { + "type" : "string" + } + }, { + "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.'.", + "in" : "query", + "name" : "groupId", + "schema" : { + "type" : "string" + } + }, { + "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-'.", + "in" : "query", + "name" : "artifactId", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Bundle" + } + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "summary" : "Get all bundles", + "tags" : [ "Bundles" ] + } + }, + "/bundles/versions" : { + "get" : { + "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_1", + "parameters" : [ { + "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.'.", + "in" : "query", + "name" : "groupId", + "schema" : { + "type" : "string" + } + }, { + "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-'.", + "in" : "query", + "name" : "artifactId", + "schema" : { + "type" : "string" + } + }, { + "description" : "Optional version to filter results. The value may be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", + "in" : "query", + "name" : "version", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BundleVersionMetadata" + } + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "summary" : "Get all bundle versions", + "tags" : [ "Bundles" ] + } + }, + "/bundles/{bundleId}" : { + "delete" : { + "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" : "deleteBundle", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Bundle" + } + } + } + }, + "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." + } + }, + "summary" : "Delete bundle", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + }, + "get" : { + "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" : "getBundle", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Bundle" + } + } + } + }, + "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." + } + }, + "summary" : "Get bundle", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions" : { + "get" : { + "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" : "getBundleVersions", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bundle versions", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}" : { + "delete" : { + "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" : "deleteBundleVersion", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete bundle version", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/buckets/{bucketId}" + } + }, + "get" : { + "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" : "getBundleVersion", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bundle version", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}/content" : { + "get" : { + "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" : "getBundleVersionContent", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "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." + } + }, + "summary" : "Get bundle version content", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions" : { + "get" : { + "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" : "getBundleVersionExtensions", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bundle version extensions", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { + "get" : { + "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" : "getBundleVersionExtension", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bundle version extension", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get bundle version extension docs", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The extension bundle identifier", + "in" : "path", + "name" : "bundleId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get bundle version extension docs details", + "tags" : [ "Bundles" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/config" : { + "get" : { + "description" : "Gets the NiFi Registry configurations.", + "operationId" : "getConfiguration", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RegistryConfiguration" + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "summary" : "Get configration", + "tags" : [ "Config" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/policies,/tenants" + } + } + }, + "/extension-repository" : { + "get" : { + "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", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo buckets", + "tags" : [ "ExtensionRepository" ] + } + }, + "/extension-repository/{bucketName}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo groups", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group id", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo artifacts", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo versions", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo version", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "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." + } + }, + "summary" : "Get extension repo version content", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo extensions", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension repo extension", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get extension repo extension docs", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The fully qualified name of the extension", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get extension repo extension details", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The bucket name", + "in" : "path", + "name" : "bucketName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get extension repo version checksum", + "tags" : [ "ExtensionRepository" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The group identifier", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifact identifier", + "in" : "path", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version", + "in" : "path", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "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." + } + }, + "summary" : "Get global extension repo version checksum", + "tags" : [ "ExtensionRepository" ] + } + }, + "/extensions" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The type of bundles to return", + "in" : "query", + "name" : "bundleType", + "schema" : { + "type" : "string", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + } + }, { + "description" : "The type of extensions to return", + "in" : "query", + "name" : "extensionType", + "schema" : { + "type" : "string", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + } + }, { + "description" : "The tags to filter on, will be used in an OR statement", + "in" : "query", + "name" : "tag", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get all extensions", + "tags" : [ "Extensions" ] + } + }, + "/extensions/provided-service-api" : { + "get" : { + "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", + "parameters" : [ { + "description" : "The name of the service API class", + "in" : "query", + "name" : "className", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The groupId of the bundle containing the service API class", + "in" : "query", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The artifactId of the bundle containing the service API class", + "in" : "query", + "name" : "artifactId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version of the bundle containing the service API class", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extensions providing service API", + "tags" : [ "Extensions" ] + } + }, + "/extensions/tags" : { + "get" : { + "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", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get extension tags", + "tags" : [ "Extensions" ] + } + }, + "/flows/fields" : { + "get" : { + "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", + "operationId" : "getAvailableFlowFields", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Fields" + } + } + } + } + }, + "summary" : "Get flow fields", + "tags" : [ "Flows" ] + } + }, + "/flows/{flowId}" : { + "get" : { + "description" : "Gets a flow by id.", + "operationId" : "getFlow_1", + "parameters" : [ { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get flow", + "tags" : [ "Flows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/flows/{flowId}/versions" : { + "get" : { + "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", + "operationId" : "getFlowVersions_1", + "parameters" : [ { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get flow versions", + "tags" : [ "Flows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/flows/{flowId}/versions/latest" : { + "get" : { + "description" : "Gets the latest version of a flow, including metadata and flow content.", + "operationId" : "getLatestFlowVersion_1", + "parameters" : [ { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get latest flow version", + "tags" : [ "Flows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "getLatestFlowVersionMetadata_1", + "parameters" : [ { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get latest flow version metadata", + "tags" : [ "Flows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "description" : "Gets the given version of a flow, including metadata and flow content.", + "operationId" : "getFlowVersion_1", + "parameters" : [ { + "description" : "The flow identifier", + "in" : "path", + "name" : "flowId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The version number", + "in" : "path", + "name" : "versionNumber", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get flow version", + "tags" : [ "Flows" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/items" : { + "get" : { + "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", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BucketItem" + } + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "summary" : "Get all items", + "tags" : [ "Items" ] + } + }, + "/items/fields" : { + "get" : { + "description" : "Retrieves the item field names for searching or sorting on bucket items.", + "operationId" : "getAvailableBucketItemFields", + "responses" : { + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Fields" + } + } + } + } + }, + "summary" : "Get item fields", + "tags" : [ "Items" ] + } + }, + "/items/{bucketId}" : { + "get" : { + "description" : "Gets the items located in the given bucket.", + "operationId" : "getItems_1", + "parameters" : [ { + "description" : "The bucket identifier", + "in" : "path", + "name" : "bucketId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get bucket items", + "tags" : [ "Items" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/buckets/{bucketId}" + } + } + }, + "/policies" : { + "get" : { + "operationId" : "getAccessPolicies", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get all access policies", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/policies" + } + }, + "post" : { + "operationId" : "createAccessPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccessPolicy" + } + } + }, + "description" : "The access policy configuration details.", + "required" : true + }, + "responses" : { + "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." + }, + "default" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccessPolicy" + } + } + } + } + }, + "summary" : "Create access policy", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/policies" + } + } + }, + "/policies/resources" : { + "get" : { + "description" : "Gets the available resources that support access/authorization policies", + "operationId" : "getResources", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Resource" + } + } + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "summary" : "Get available resources", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/policies" + } + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "description" : "Gets an access policy for the specified action and resource", + "operationId" : "getAccessPolicyForResource", + "parameters" : [ { + "description" : "The request action.", + "in" : "path", + "name" : "action", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "The resource of the policy.", + "in" : "path", + "name" : "resource", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : ".+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get access policy for resource", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/policies" + } + } + }, + "/policies/{id}" : { + "delete" : { + "operationId" : "removeAccessPolicy", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete access policy", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "delete", + "resource" : "/policies" + } + }, + "get" : { + "operationId" : "getAccessPolicy", + "parameters" : [ { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get access policy", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/policies" + } + }, + "put" : { + "operationId" : "updateAccessPolicy", + "parameters" : [ { + "description" : "The access policy id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccessPolicy" + } + } + }, + "description" : "The access policy configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Update access policy", + "tags" : [ "Policies" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/policies" + } + } + }, + "/tenants/user-groups" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroups", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get user groups", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/tenants" + } + }, + "post" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUserGroup", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserGroup" + } + } + }, + "description" : "The user group configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create user group", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/tenants" + } + } + }, + "/tenants/user-groups/{id}" : { + "delete" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUserGroup", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete user group", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "delete", + "resource" : "/tenants" + } + }, + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroup", + "parameters" : [ { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get user group", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/tenants" + } + }, + "put" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUserGroup", + "parameters" : [ { + "description" : "The user group id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserGroup" + } + } + }, + "description" : "The user group configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Update user group", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/tenants" + } + } + }, + "/tenants/users" : { + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUsers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get all users", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/tenants" + } + }, + "post" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUser", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User" + } + } + }, + "description" : "The user configuration details.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Create user", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/tenants" + } + } + }, + "/tenants/users/{id}" : { + "delete" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUser", + "parameters" : [ { + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "in" : "query", + "name" : "version", + "required" : true, + "schema" : { + "$ref" : "#/components/schemas/LongParameter" + } + }, { + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "in" : "query", + "name" : "clientId", + "schema" : { + "$ref" : "#/components/schemas/ClientIdParameter" + } + }, { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Delete user", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "delete", + "resource" : "/tenants" + } + }, + "get" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUser", + "parameters" : [ { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Get user", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "read", + "resource" : "/tenants" + } + }, + "put" : { + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUser", + "parameters" : [ { + "description" : "The user id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/User" + } + } + }, + "description" : "The user configuration details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/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." + } + }, + "summary" : "Update user", + "tags" : [ "Tenants" ], + "x-access-policy" : { + "action" : "write", + "resource" : "/tenants" + } + } + } + }, + "components" : { + "schemas" : { + "AccessPolicy" : { + "type" : "object", + "properties" : { + "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 + }, + "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." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "items" : { + "$ref" : "#/components/schemas/Tenant" + }, + "uniqueItems" : true + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "items" : { + "$ref" : "#/components/schemas/Tenant" + }, + "uniqueItems" : true + } + } + }, + "AccessPolicySummary" : { + "type" : "object", + "description" : "The access policies granted to this tenant.", + "properties" : { + "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 + }, + "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." + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + } + }, + "readOnly" : true + }, + "AllowableValue" : { + "type" : "object", + "description" : "The allowable values for this property", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the allowable value" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the allowable value" + }, + "value" : { + "type" : "string", + "description" : "The value of the allowable value" + } + } + }, + "Attribute" : { + "type" : "object", + "description" : "The attributes written to FlowFiles by the extension", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the attribute" + }, + "name" : { + "type" : "string", + "description" : "The name of the attribute" + } + } + }, + "BatchSize" : { + "type" : "object", + "description" : "The batch settings for data transmission.", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of FlowFiles to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + } + } + }, + "Bucket" : { + "type" : "object", + "description" : "The bucket where the flow is located", + "properties" : { + "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" + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "minimum" : 1, + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "minLength" : 1, + "readOnly" : true + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket.", + "minLength" : 1 + }, + "permissions" : { + "$ref" : "#/components/schemas/Permissions" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + } + }, + "readOnly" : true, + "required" : [ "identifier", "name" ] + }, + "BucketItem" : { + "type" : "object", + "properties" : { + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created.", + "minLength" : 1 + }, + "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.", + "minimum" : 1, + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "minLength" : 1, + "readOnly" : true + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "minimum" : 1, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item.", + "minLength" : 1 + }, + "permissions" : { + "$ref" : "#/components/schemas/Permissions" + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + } + }, + "required" : [ "bucketIdentifier", "identifier", "name", "type" ] + }, + "BuildInfo" : { + "type" : "object", + "description" : "The build information about this version", + "properties" : { + "buildBranch" : { + "type" : "string", + "description" : "The branch used to build the version of the bundle" + }, + "buildFlags" : { + "type" : "string", + "description" : "The flags used to build the version of the bundle" + }, + "buildRevision" : { + "type" : "string", + "description" : "The revision used to build the version of the bundle" + }, + "buildTag" : { + "type" : "string", + "description" : "The tag used to build the version of the bundle" + }, + "buildTool" : { + "type" : "string", + "description" : "The tool 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", + "description" : "The details of the artifact that bundled this parameter provider.", + "properties" : { + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleInfo" : { + "type" : "object", + "description" : "The information for the bundle where this extension is located", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle" + }, + "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" + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API the bundle was built against" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleVersion" : { + "type" : "object", + "properties" : { + "bucket" : { + "$ref" : "#/components/schemas/Bucket" + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "dependencies" : { + "type" : "array", + "description" : "The set of other bundle versions that this version is dependent on", + "items" : { + "$ref" : "#/components/schemas/BundleVersionDependency" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "filename" : { + "type" : "string" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "versionMetadata" : { + "$ref" : "#/components/schemas/BundleVersionMetadata" + } + }, + "required" : [ "versionMetadata" ] + }, + "BundleVersionDependency" : { + "type" : "object", + "description" : "The set of other bundle versions that this version is dependent on", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle dependency", + "minLength" : 1 + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle dependency", + "minLength" : 1 + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle dependency", + "minLength" : 1 + } + }, + "readOnly" : true, + "required" : [ "artifactId", "groupId", "version" ] + }, + "BundleVersionMetadata" : { + "type" : "object", + "properties" : { + "artifactId" : { + "type" : "string" + }, + "author" : { + "type" : "string", + "description" : "The identity that created this version", + "minLength" : 1 + }, + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket the extension bundle belongs to", + "minLength" : 1 + }, + "buildInfo" : { + "$ref" : "#/components/schemas/BuildInfo" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the extension bundle this version is for", + "minLength" : 1 + }, + "contentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the binary content for this version in bytes", + "minimum" : 0 + }, + "description" : { + "type" : "string", + "description" : "The description for this version" + }, + "groupId" : { + "type" : "string" + }, + "id" : { + "type" : "string", + "description" : "The id of this version of the extension bundle", + "minLength" : 1 + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "sha256" : { + "type" : "string", + "description" : "The hex representation of the SHA-256 digest of the binary content for this version", + "minLength" : 1 + }, + "sha256Supplied" : { + "type" : "boolean", + "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API that this bundle version was built against", + "minLength" : 1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the create date of this version", + "minimum" : 1 + }, + "version" : { + "type" : "string", + "description" : "The version of the extension bundle", + "minLength" : 1 + } + }, + "required" : [ "author", "bucketId", "buildInfo", "bundleId", "contentSize", "id", "sha256", "sha256Supplied", "systemApiVersion", "version" ] + }, + "ClientIdParameter" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string" + } + } + }, + "ComponentDifference" : { + "type" : "object", + "description" : "The list of changes related to this component between the 2 versions.", + "properties" : { + "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." + }, + "valueA" : { + "type" : "string", + "description" : "The earlier value from the difference." + }, + "valueB" : { + "type" : "string", + "description" : "The newer value from the difference." + } + } + }, + "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." + }, + "differences" : { + "type" : "array", + "description" : "The list of changes related to this component between the 2 versions.", + "items" : { + "$ref" : "#/components/schemas/ComponentDifference" + }, + "uniqueItems" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The process group id for this component." + } + } + }, + "ConfigurationStep" : { + "type" : "object", + "description" : "The configuration steps for a Connector extension", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the configuration step" + }, + "name" : { + "type" : "string", + "description" : "The name of the configuration step" + }, + "propertyGroups" : { + "type" : "array", + "description" : "The property groups in this configuration step", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyGroup" + }, + "xml" : { + "wrapped" : true + } + }, + "stepDependencies" : { + "type" : "array", + "description" : "The dependencies that this step has on other steps", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStepDependency" + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "ConfigurationStepDependency" : { + "type" : "object", + "description" : "The dependencies that this step has on other steps", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that enable this step", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that enable this step", + "xml" : { + "name" : "dependentValue" + } + }, + "xml" : { + "wrapped" : true + } + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property within the step that this step depends on" + }, + "stepName" : { + "type" : "string", + "description" : "The name of the step that this step depends on" + } + } + }, + "ConnectableComponent" : { + "type" : "object", + "description" : "The destination of the connection.", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The name 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" ] + } + } + }, + "ConnectorProperty" : { + "type" : "object", + "description" : "The properties in this group", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "The allowable values for this property", + "items" : { + "$ref" : "#/components/schemas/AllowableValue" + }, + "xml" : { + "wrapped" : true + } + }, + "allowableValuesFetchable" : { + "type" : "boolean", + "description" : "Whether or not the allowable values can be fetched dynamically" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value of the property" + }, + "dependencies" : { + "type" : "array", + "description" : "The properties that this property depends on", + "items" : { + "$ref" : "#/components/schemas/ConnectorPropertyDependency" + }, + "xml" : { + "wrapped" : true + } + }, + "description" : { + "type" : "string", + "description" : "The description of the property" + }, + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "propertyType" : { + "type" : "string", + "description" : "The type of the property", + "enum" : [ "STRING", "INTEGER", "BOOLEAN", "FLOAT", "DOUBLE", "STRING_LIST", "SECRET", "ASSET", "ASSET_LIST" ] + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + } + } + }, + "ConnectorPropertyDependency" : { + "type" : "object", + "description" : "The properties that this property depends on", + "properties" : { + "dependentValues" : { + "type" : "array", + "description" : "The values of the dependent property that enable this property", + "items" : { + "type" : "string", + "description" : "The values of the dependent property that enable this property", + "xml" : { + "name" : "dependentValue" + } + }, + "xml" : { + "wrapped" : true + } + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the property that this property depends on" + } + } + }, + "ConnectorPropertyGroup" : { + "type" : "object", + "description" : "The property groups in this configuration step", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the property group" + }, + "name" : { + "type" : "string", + "description" : "The name of the property group" + }, + "properties" : { + "type" : "array", + "description" : "The properties in this group", + "items" : { + "$ref" : "#/components/schemas/ConnectorProperty" + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "description" : "Lists the APIs this Controller Service implements.", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "description" : "The controller service required by this property, or null if none is required", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API" + }, + "className" : { + "type" : "string", + "description" : "The class name of the service API" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API" + } + } + }, + "CurrentUser" : { + "type" : "object", + "properties" : { + "anonymous" : { + "type" : "boolean", + "description" : "Indicates if the current user is anonymous", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The identity of the current user", + "readOnly" : true + }, + "loginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi Registry instance supports logging in" + }, + "oidcloginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" + }, + "resourcePermissions" : { + "$ref" : "#/components/schemas/ResourcePermissions" + } + } + }, + "DefaultSchedule" : { + "type" : "object", + "description" : "The default schedule for a processor reporting task", + "properties" : { + "concurrentTasks" : { + "type" : "string", + "description" : "The default concurrent tasks" + }, + "period" : { + "type" : "string", + "description" : "The default scheduling period" + }, + "strategy" : { + "type" : "string", + "description" : "The default scheduling strategy" + } + } + }, + "DefaultSettings" : { + "type" : "object", + "description" : "The default settings for a processor", + "properties" : { + "bulletinLevel" : { + "type" : "string", + "description" : "The default bulletin level" + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The default penalty duration" + }, + "yieldDuration" : { + "type" : "string", + "description" : "The default yield duration" + } + } + }, + "Dependency" : { + "type" : "object", + "description" : "The properties that this property depends on", + "properties" : { + "dependentValues" : { + "$ref" : "#/components/schemas/DependentValues" + }, + "propertyDisplayName" : { + "type" : "string", + "description" : "The display name of the dependent property" + }, + "propertyName" : { + "type" : "string", + "description" : "The name of the dependent property" + } + } + }, + "DependentValues" : { + "type" : "object", + "description" : "The values of the dependent property that enable the depending property", + "properties" : { + "values" : { + "type" : "array", + "description" : "The dependent values", + "items" : { + "type" : "string", + "description" : "The dependent values", + "xml" : { + "name" : "dependentValue" + } + }, + "xml" : { + "name" : "dependentValue" + } + } + } + }, + "DeprecationNotice" : { + "type" : "object", + "description" : "The deprecation notice of the extension", + "properties" : { + "alternatives" : { + "type" : "array", + "description" : "The alternatives to use", + "items" : { + "type" : "string", + "description" : "The alternatives to use", + "xml" : { + "name" : "alternative" + } + }, + "xml" : { + "wrapped" : true + } + }, + "reason" : { + "type" : "string", + "description" : "The reason for the deprecation" + } + } + }, + "DynamicProperty" : { + "type" : "object", + "description" : "The dynamic properties of the extension", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "ENVIRONMENT", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + }, + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "description" : "The dynamic relationships of the extension", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + }, + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + } + } + }, + "Extension" : { + "type" : "object", + "properties" : { + "configurationSteps" : { + "type" : "array", + "description" : "The configuration steps for a Connector extension", + "items" : { + "$ref" : "#/components/schemas/ConfigurationStep" + }, + "xml" : { + "wrapped" : true + } + }, + "defaultSchedule" : { + "$ref" : "#/components/schemas/DefaultSchedule" + }, + "defaultSettings" : { + "$ref" : "#/components/schemas/DefaultSettings" + }, + "deprecationNotice" : { + "$ref" : "#/components/schemas/DeprecationNotice" + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "dynamicProperties" : { + "type" : "array", + "description" : "The dynamic properties of the extension", + "items" : { + "$ref" : "#/components/schemas/DynamicProperty" + }, + "xml" : { + "wrapped" : true + } + }, + "dynamicRelationship" : { + "$ref" : "#/components/schemas/DynamicRelationship" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement of the extension", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "multiProcessorUseCases" : { + "type" : "array", + "description" : "Zero or more documented use cases for how the processor may be used in conjunction with other processors", + "items" : { + "$ref" : "#/components/schemas/MultiProcessorUseCase" + }, + "xml" : { + "wrapped" : true + } + }, + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "primaryNodeOnly" : { + "type" : "boolean", + "description" : "Indicates that a processor should be scheduled only on the primary node" + }, + "properties" : { + "type" : "array", + "description" : "The properties of the extension", + "items" : { + "$ref" : "#/components/schemas/Property" + }, + "xml" : { + "wrapped" : true + } + }, + "providedServiceAPIs" : { + "type" : "array", + "description" : "The service APIs provided by this extension", + "items" : { + "$ref" : "#/components/schemas/ProvidedServiceAPI" + }, + "xml" : { + "wrapped" : true + } + }, + "readsAttributes" : { + "type" : "array", + "description" : "The attributes read from FlowFiles by the extension", + "items" : { + "$ref" : "#/components/schemas/Attribute" + }, + "xml" : { + "wrapped" : true + } + }, + "relationships" : { + "type" : "array", + "description" : "The relationships of the extension", + "items" : { + "$ref" : "#/components/schemas/Relationship" + }, + "xml" : { + "wrapped" : true + } + }, + "restricted" : { + "$ref" : "#/components/schemas/Restricted" + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other extensions to see", + "items" : { + "type" : "string", + "description" : "The names of other extensions to see", + "xml" : { + "name" : "see" + } + }, + "xml" : { + "wrapped" : true + } + }, + "sideEffectFree" : { + "type" : "boolean", + "description" : "Indicates that a processor is side effect free" + }, + "stateful" : { + "$ref" : "#/components/schemas/Stateful" + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Indicates that a processor supports batching" + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean" + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The resource considerations of the extension", + "items" : { + "$ref" : "#/components/schemas/SystemResourceConsideration" + }, + "xml" : { + "wrapped" : true + } + }, + "tags" : { + "type" : "array", + "description" : "The tags of the extension", + "items" : { + "type" : "string", + "description" : "The tags of the extension", + "xml" : { + "name" : "tag" + } + }, + "xml" : { + "wrapped" : true + } + }, + "triggerSerially" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered serially" + }, + "triggerWhenAnyDestinationAvailable" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered when any destinations have space for FlowFiles" + }, + "triggerWhenEmpty" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered when the incoming queues are empty" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "useCases" : { + "type" : "array", + "description" : "Zero or more documented use cases for how the extension may be used", + "items" : { + "$ref" : "#/components/schemas/UseCase" + }, + "xml" : { + "wrapped" : true + } + }, + "writesAttributes" : { + "type" : "array", + "description" : "The attributes written to FlowFiles by the extension", + "items" : { + "$ref" : "#/components/schemas/Attribute" + }, + "xml" : { + "wrapped" : true + } + } + }, + "required" : [ "name", "type" ] + }, + "ExtensionFilterParams" : { + "type" : "object", + "description" : "The filter parameters submitted for the request", + "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", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "tags" : { + "type" : "array", + "description" : "The tags", + "items" : { + "type" : "string", + "description" : "The tags" + }, + "uniqueItems" : true + } + } + }, + "ExtensionMetadata" : { + "type" : "object", + "description" : "The metadata for the extensions", + "properties" : { + "bundleInfo" : { + "$ref" : "#/components/schemas/BundleInfo" + }, + "deprecationNotice" : { + "$ref" : "#/components/schemas/DeprecationNotice" + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the extension" + }, + "hasAdditionalDetails" : { + "type" : "boolean", + "description" : "Whether or not the extension has additional detail documentation" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "linkDocs" : { + "$ref" : "#/components/schemas/Link" + }, + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "providedServiceAPIs" : { + "type" : "array", + "description" : "The service APIs provided by the extension", + "items" : { + "$ref" : "#/components/schemas/ProvidedServiceAPI" + } + }, + "restricted" : { + "$ref" : "#/components/schemas/Restricted" + }, + "tags" : { + "type" : "array", + "description" : "The tags of the extension", + "items" : { + "type" : "string", + "description" : "The tags of the extension" + } + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + } + } + }, + "ExtensionMetadataContainer" : { + "type" : "object", + "properties" : { + "extensions" : { + "type" : "array", + "description" : "The metadata for the extensions", + "items" : { + "$ref" : "#/components/schemas/ExtensionMetadata" + }, + "uniqueItems" : true + }, + "filterParams" : { + "$ref" : "#/components/schemas/ExtensionFilterParams" + }, + "numResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extensions in the response" + } + } + }, + "ExtensionRepoArtifact" : { + "type" : "object", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + } + } + }, + "ExtensionRepoBucket" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + } + } + }, + "ExtensionRepoGroup" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + } + } + }, + "ExtensionRepoVersion" : { + "type" : "object", + "properties" : { + "downloadLink" : { + "$ref" : "#/components/schemas/Link" + }, + "extensionsLink" : { + "$ref" : "#/components/schemas/Link" + }, + "sha256Link" : { + "$ref" : "#/components/schemas/Link" + }, + "sha256Supplied" : { + "type" : "boolean", + "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", + "readOnly" : true + } + } + }, + "ExtensionRepoVersionSummary" : { + "type" : "object", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + }, + "author" : { + "type" : "string", + "description" : "The identity of the user that created this version" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when this version was created" + }, + "version" : { + "type" : "string", + "description" : "The version" + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "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", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + } + }, + "FormDataContentDisposition" : { + "type" : "object", + "properties" : { + "creationDate" : { + "type" : "string", + "format" : "date-time" + }, + "fileName" : { + "type" : "string" + }, + "modificationDate" : { + "type" : "string", + "format" : "date-time" + }, + "name" : { + "type" : "string" + }, + "parameters" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "readDate" : { + "type" : "string", + "format" : "date-time" + }, + "size" : { + "type" : "integer", + "format" : "int64" + }, + "type" : { + "type" : "string" + } + } + }, + "Link" : { + "type" : "object", + "description" : "An WebLink to this entity.", + "properties" : { + "params" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "rel" : { + "type" : "string" + }, + "rels" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "title" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "uri" : { + "type" : "string", + "format" : "uri" + }, + "uriBuilder" : { + "$ref" : "#/components/schemas/UriBuilder" + } + }, + "readOnly" : true + }, + "ListenPortDefinition" : { + "type" : "object", + "description" : "The optional listen port definition", + "properties" : { + "applicationProtocols" : { + "type" : "array", + "description" : "The application protocols that this listen port could support (if any)", + "items" : { + "type" : "string", + "description" : "The application protocols that this listen port could support (if any)", + "xml" : { + "name" : "applicationProtocol" + } + }, + "xml" : { + "wrapped" : true + } + }, + "transportProtocol" : { + "type" : "string", + "description" : "The transport protocol used by this listen port", + "enum" : [ "TCP", "UDP" ] + } + } + }, + "LongParameter" : { + "type" : "object", + "properties" : { + "long" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "MultiProcessorUseCase" : { + "type" : "object", + "description" : "Zero or more documented use cases for how the processor may be used in conjunction with other processors", + "properties" : { + "description" : { + "type" : "string" + }, + "keywords" : { + "type" : "array", + "items" : { + "type" : "string", + "xml" : { + "name" : "keyword" + } + }, + "xml" : { + "wrapped" : true + } + }, + "notes" : { + "type" : "string" + }, + "processorConfigurations" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ProcessorConfiguration" + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "ParameterProviderReference" : { + "type" : "object", + "description" : "Contains basic information about parameter providers referenced in the versioned flow.", + "properties" : { + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "identifier" : { + "type" : "string", + "description" : "The identifier of the parameter provider" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the parameter provider class." + } + } + }, + "Permissions" : { + "type" : "object", + "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", + "properties" : { + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + }, + "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 + } + }, + "readOnly" : true + }, + "Position" : { + "type" : "object", + "description" : "The position of a component on the graph", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "ProcessorConfiguration" : { + "type" : "object", + "properties" : { + "configuration" : { + "type" : "string" + }, + "processorClassName" : { + "type" : "string" + } + } + }, + "Property" : { + "type" : "object", + "description" : "The properties of the extension", + "properties" : { + "allowableValues" : { + "type" : "array", + "description" : "The allowable values for this property", + "items" : { + "$ref" : "#/components/schemas/AllowableValue" + }, + "xml" : { + "wrapped" : true + } + }, + "controllerServiceDefinition" : { + "$ref" : "#/components/schemas/ControllerServiceDefinition" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value" + }, + "dependencies" : { + "type" : "array", + "description" : "The properties that this property depends on", + "items" : { + "$ref" : "#/components/schemas/Dependency" + }, + "xml" : { + "wrapped" : true + } + }, + "description" : { + "type" : "string", + "description" : "The description" + }, + "displayName" : { + "type" : "string", + "description" : "The display name" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the processor is dynamic" + }, + "dynamicallyModifiesClasspath" : { + "type" : "boolean", + "description" : "Whether or not the processor dynamically modifies the classpath" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language support", + "enum" : [ "NONE", "ENVIRONMENT", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + }, + "listenPortDefinition" : { + "$ref" : "#/components/schemas/ListenPortDefinition" + }, + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + }, + "resourceDefinition" : { + "$ref" : "#/components/schemas/ResourceDefinition" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is sensitive" + } + } + }, + "ProvidedServiceAPI" : { + "type" : "object", + "description" : "The service APIs provided by the extension", + "properties" : { + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API being provided", + "minLength" : 1 + }, + "className" : { + "type" : "string", + "description" : "The class name of the service API being provided", + "minLength" : 1 + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API being provided", + "minLength" : 1 + }, + "version" : { + "type" : "string", + "description" : "The version of the service API being provided", + "minLength" : 1 + } + }, + "required" : [ "artifactId", "className", "groupId", "version" ] + }, + "RegistryAbout" : { + "type" : "object", + "properties" : { + "registryAboutVersion" : { + "type" : "string", + "description" : "The version string for this Nifi Registry", + "readOnly" : true + } + } + }, + "RegistryConfiguration" : { + "type" : "object", + "properties" : { + "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 + }, + "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 + } + } + }, + "Relationship" : { + "type" : "object", + "description" : "The relationships of the extension", + "properties" : { + "autoTerminated" : { + "type" : "boolean", + "description" : "Whether or not the relationship is auto-terminated by default" + }, + "description" : { + "type" : "string", + "description" : "The description of the relationship" + }, + "name" : { + "type" : "string", + "description" : "The name of the relationship" + } + } + }, + "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 + } + } + }, + "ResourceDefinition" : { + "type" : "object", + "description" : "The optional resource definition", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource definition", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resources", + "items" : { + "type" : "string", + "description" : "The types of resources", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ], + "xml" : { + "name" : "resourceType" + } + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "ResourcePermissions" : { + "type" : "object", + "description" : "A summary top-level resource access policies granted to this tenant.", + "properties" : { + "anyTopLevelResource" : { + "$ref" : "#/components/schemas/Permissions" + }, + "buckets" : { + "$ref" : "#/components/schemas/Permissions" + }, + "policies" : { + "$ref" : "#/components/schemas/Permissions" + }, + "proxy" : { + "$ref" : "#/components/schemas/Permissions" + }, + "tenants" : { + "$ref" : "#/components/schemas/Permissions" + } + }, + "readOnly" : true + }, + "Restricted" : { + "type" : "object", + "description" : "The restrictions of the extension", + "properties" : { + "generalRestrictionExplanation" : { + "type" : "string", + "description" : "The general restriction for the extension, or null if only specific restrictions exist" + }, + "restrictions" : { + "type" : "array", + "description" : "The specific restrictions", + "items" : { + "$ref" : "#/components/schemas/Restriction" + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "Restriction" : { + "type" : "object", + "description" : "The specific restrictions", + "properties" : { + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction", + "minLength" : 1 + }, + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction", + "minLength" : 1 + } + }, + "required" : [ "explanation", "requiredPermission" ] + }, + "RevisionInfo" : { + "type" : "object", + "description" : "The revision information for an entity managed through the REST API.", + "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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the entity.", + "readOnly" : true + }, + "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." + } + }, + "readOnly" : true + }, + "Stateful" : { + "type" : "object", + "description" : "The information about how the extension stores state", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description for how the extension stores state" + }, + "scopes" : { + "type" : "array", + "description" : "The scopes used to store state", + "items" : { + "type" : "string", + "description" : "The scopes used to store state", + "enum" : [ "CLUSTER", "LOCAL" ], + "xml" : { + "name" : "scope" + } + }, + "xml" : { + "wrapped" : true + } + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "description" : "The resource considerations of the extension", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + }, + "resource" : { + "type" : "string", + "description" : "The resource to consider" + } + } + }, + "TagCount" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of occurrences of the given tag" + }, + "tag" : { + "type" : "string", + "description" : "The tag label" + } + } + }, + "Tenant" : { + "type" : "object", + "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", + "properties" : { + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "items" : { + "$ref" : "#/components/schemas/AccessPolicySummary" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "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." + }, + "resourcePermissions" : { + "$ref" : "#/components/schemas/ResourcePermissions" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + } + } + }, + "UriBuilder" : { + "type" : "object" + }, + "UseCase" : { + "type" : "object", + "description" : "Zero or more documented use cases for how the extension may be used", + "properties" : { + "configuration" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "inputRequirement" : { + "type" : "string", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "keywords" : { + "type" : "array", + "items" : { + "type" : "string", + "xml" : { + "name" : "keyword" + } + }, + "xml" : { + "wrapped" : true + } + }, + "notes" : { + "type" : "string" + } + } + }, + "User" : { + "type" : "object", + "properties" : { + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "items" : { + "$ref" : "#/components/schemas/AccessPolicySummary" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "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." + }, + "resourcePermissions" : { + "$ref" : "#/components/schemas/ResourcePermissions" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs.", + "items" : { + "$ref" : "#/components/schemas/Tenant" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "UserGroup" : { + "type" : "object", + "properties" : { + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "items" : { + "$ref" : "#/components/schemas/AccessPolicySummary" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "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." + }, + "resourcePermissions" : { + "$ref" : "#/components/schemas/ResourcePermissions" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + }, + "users" : { + "type" : "array", + "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", + "items" : { + "$ref" : "#/components/schemas/Tenant" + }, + "uniqueItems" : true + } + } + }, + "VersionedAsset" : { + "type" : "object", + "description" : "The assets that are referenced by this parameter", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the asset" + }, + "name" : { + "type" : "string", + "description" : "The name of the asset" + } + } + }, + "VersionedComponentState" : { + "type" : "object", + "description" : "The state of the component, if exported with state", + "properties" : { + "clusterState" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The cluster-scoped state of the component, or null if not exported" + }, + "description" : "The cluster-scoped state of the component, or null if not exported" + }, + "localNodeStates" : { + "type" : "array", + "description" : "The local-scoped state of the component ordered by node ordinal index, or null if not exported", + "items" : { + "$ref" : "#/components/schemas/VersionedNodeState" + } + } + } + }, + "VersionedConnection" : { + "type" : "object", + "description" : "The Connections", + "properties" : { + "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." + }, + "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." + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/components/schemas/Position" + } + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "destination" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "The amount of time a FlowFile may be in the flow before it will be automatically aged out of the flow. Once a FlowFile reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details." + }, + "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. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "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." + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string", + "description" : "The comparators used to prioritize the queue." + } + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "items" : { + "type" : "string", + "description" : "The selected relationship that comprise the connection." + }, + "uniqueItems" : true + }, + "source" : { + "$ref" : "#/components/schemas/ConnectableComponent" + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "description" : "The Controller Services", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "componentState" : { + "$ref" : "#/components/schemas/VersionedComponentState" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/components/schemas/ControllerServiceAPI" + } + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedPropertyDescriptor" + }, + "description" : "The property descriptors for the component." + }, + "scheduledState" : { + "type" : "string", + "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "description" : "The flow this snapshot is for", + "properties" : { + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created.", + "minLength" : 1 + }, + "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.", + "minimum" : 1, + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "minLength" : 1, + "readOnly" : true + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "minimum" : 1, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item.", + "minLength" : 1 + }, + "permissions" : { + "$ref" : "#/components/schemas/Permissions" + }, + "revision" : { + "$ref" : "#/components/schemas/RevisionInfo" + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "minimum" : 0, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "bucketIdentifier", "identifier", "name", "type" ] + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "properties" : { + "branch" : { + "type" : "string", + "description" : "The name of the branch that the flow resides in" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + }, + "registryId" : { + "type" : "string", + "description" : "The identifier of the Flow Registry that contains the flow" + }, + "storageLocation" : { + "type" : "string", + "description" : "The location of the Flow Registry that stores the flow" + }, + "version" : { + "type" : "string", + "description" : "The version of the flow" + } + } + }, + "VersionedFlowDifference" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket that the flow is stored in." + }, + "componentDifferenceGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ComponentDifferenceGroup" + }, + "uniqueItems" : true + }, + "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." + } + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "properties" : { + "bucket" : { + "$ref" : "#/components/schemas/Bucket" + }, + "externalControllerServices" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ExternalControllerServiceReference" + }, + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow." + }, + "flow" : { + "$ref" : "#/components/schemas/VersionedFlow" + }, + "flowContents" : { + "$ref" : "#/components/schemas/VersionedProcessGroup" + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "latest" : { + "type" : "boolean" + }, + "parameterContexts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedParameterContext" + }, + "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." + }, + "parameterProviders" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/ParameterProviderReference" + }, + "description" : "Contains basic information about parameter providers referenced in the versioned flow." + }, + "snapshotMetadata" : { + "$ref" : "#/components/schemas/VersionedFlowSnapshotMetadata" + } + }, + "required" : [ "flowContents", "snapshotMetadata" ] + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "properties" : { + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "minLength" : 1, + "readOnly" : true + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to.", + "minLength" : 1 + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to.", + "minLength" : 1 + }, + "link" : { + "$ref" : "#/components/schemas/Link" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "minimum" : 1, + "readOnly" : true + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + } + }, + "required" : [ "author", "bucketIdentifier", "flowIdentifier" ] + }, + "VersionedFunnel" : { + "type" : "object", + "description" : "The Funnels", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "description" : "The Labels", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc)." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + } + } + }, + "VersionedListenPortDefinition" : { + "type" : "object", + "description" : "Returns the Listen Port Definition for the port this property specifies, if applicable", + "properties" : { + "applicationProtocols" : { + "type" : "array", + "description" : "The application protocol(s) that the listen port could support (if any)", + "items" : { + "type" : "string", + "description" : "The application protocol(s) that the listen port could support (if any)" + } + }, + "transportProtocol" : { + "type" : "string", + "description" : "The transport protocol used by the listen port", + "enum" : [ "TCP", "UDP" ] + } + } + }, + "VersionedNodeState" : { + "type" : "object", + "description" : "The state entries for a single node", + "properties" : { + "state" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The state key-value pairs for this node" + }, + "description" : "The state key-value pairs for this node" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "description" : "The parameters in the context", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is provided by a ParameterProvider" + }, + "referencedAssets" : { + "type" : "array", + "description" : "The assets that are referenced by this parameter", + "items" : { + "$ref" : "#/components/schemas/VersionedAsset" + } + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "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.", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "The names of additional parameter contexts from which to inherit parameters", + "items" : { + "type" : "string", + "description" : "The names of additional parameter contexts from which to inherit parameters" + } + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "parameterGroupName" : { + "type" : "string", + "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" + }, + "parameterProvider" : { + "type" : "string", + "description" : "The identifier of an optional parameter provider" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "items" : { + "$ref" : "#/components/schemas/VersionedParameter" + }, + "uniqueItems" : true + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" + } + } + }, + "VersionedPort" : { + "type" : "object", + "description" : "The Output Ports", + "properties" : { + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "portFunction" : { + "type" : "string", + "description" : "Specifies how the Port should function", + "enum" : [ "STANDARD", "FAILURE" ] + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "description" : "The contents of the versioned flow", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "items" : { + "$ref" : "#/components/schemas/VersionedConnection" + }, + "uniqueItems" : true + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "items" : { + "$ref" : "#/components/schemas/VersionedControllerService" + }, + "uniqueItems" : true + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "executionEngine" : { + "type" : "string", + "description" : "The Execution Engine that should be used to run the components within the group.", + "enum" : [ "STANDARD", "STATELESS", "INHERITED" ] + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "items" : { + "$ref" : "#/components/schemas/VersionedFunnel" + }, + "uniqueItems" : true + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "items" : { + "$ref" : "#/components/schemas/VersionedLabel" + }, + "uniqueItems" : true + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "maxConcurrentTasks" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "items" : { + "$ref" : "#/components/schemas/VersionedPort" + }, + "uniqueItems" : true + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessGroup" + }, + "uniqueItems" : true + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "items" : { + "$ref" : "#/components/schemas/VersionedProcessor" + }, + "uniqueItems" : true + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteProcessGroup" + }, + "uniqueItems" : true + }, + "scheduledState" : { + "type" : "string", + "description" : "The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "statelessFlowTimeout" : { + "type" : "string", + "description" : "The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure" + }, + "versionedFlowCoordinates" : { + "$ref" : "#/components/schemas/VersionedFlowCoordinates" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "description" : "The Processors", + "properties" : { + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the processor." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "The names of all relationships that cause a FlowFile 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.", + "items" : { + "type" : "string", + "description" : "The names of all relationships that cause a FlowFile 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 + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "bundle" : { + "$ref" : "#/components/schemas/Bundle" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "componentState" : { + "$ref" : "#/components/schemas/VersionedComponentState" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a FlowFile." + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "description" : "The properties for the component. Properties whose value is not set will only contain the property name." + }, + "propertyDescriptors" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/VersionedPropertyDescriptor" + }, + "description" : "The property descriptors for the component." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "items" : { + "type" : "string", + "description" : "All the relationships should be retried." + }, + "uniqueItems" : true + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "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" : "Indicates how the processor should be scheduled to run." + }, + "style" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Stylistic data for rendering in a UI" + }, + "description" : "Stylistic data for rendering in a UI" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the property is user-defined" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "listenPortDefinition" : { + "$ref" : "#/components/schemas/VersionedListenPortDefinition" + }, + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "resourceDefinition" : { + "$ref" : "#/components/schemas/VersionedResourceDefinition" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "properties" : { + "batchSize" : { + "$ref" : "#/components/schemas/BatchSize" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit FlowFiles to the target port concurrently." + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the FlowFiles are compressed when sent to the target port." + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "description" : "The Remote Process Groups", + "properties" : { + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "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", "REPORTING_TASK", "FLOW_ANALYSIS_RULE", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "FLOW_REGISTRY_CLIENT", "CONNECTOR" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + }, + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteGroupPort" + }, + "uniqueItems" : true + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "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." + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "items" : { + "$ref" : "#/components/schemas/VersionedRemoteGroupPort" + }, + "uniqueItems" : true + }, + "position" : { + "$ref" : "#/components/schemas/Position" + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "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." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications. Possible returned values: RAW, HTTP." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + } + } + }, + "VersionedResourceDefinition" : { + "type" : "object", + "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "items" : { + "type" : "string", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + }, + "uniqueItems" : true + } + } + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/swagger_templates/configuration.mustache b/resources/client_gen/swagger_templates/configuration.mustache index 111b3422..8d300f21 100644 --- a/resources/client_gen/swagger_templates/configuration.mustache +++ b/resources/client_gen/swagger_templates/configuration.mustache @@ -36,6 +36,10 @@ class Configuration(object): self.api_client = None # Temp file folder for downloading files self.temp_folder_path = None + # Validate enum-constrained model fields when they are set. + # Set to False to accept values the generated enums do not list yet + # (e.g. a newer server than the spec the client was generated from). + self.client_side_validation = True # Authentication Settings self.force_basic_auth = False diff --git a/resources/client_gen/swagger_templates/model.mustache b/resources/client_gen/swagger_templates/model.mustache index c272023b..d02fd7c8 100644 --- a/resources/client_gen/swagger_templates/model.mustache +++ b/resources/client_gen/swagger_templates/model.mustache @@ -5,6 +5,8 @@ from pprint import pformat import re +from ..configuration import Configuration + class {{classname}}(object): """ @@ -89,32 +91,36 @@ class {{classname}}(object): {{/isReadOnly}} {{/required}} {{#isEnum}} + if Configuration().client_side_validation: {{#isContainer}} - allowed_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}, {{/enumVars}}{{/allowableValues}}] + allowed_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}, {{/enumVars}}{{/allowableValues}}] {{#isListContainer}} - if not set({{{name}}}).issubset(set(allowed_values)): - raise ValueError( - "Invalid values for `{{{name}}}` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set({{{name}}})-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + if not set({{{name}}}).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `{{{name}}}` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set({{{name}}})-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) {{/isListContainer}} {{#isMapContainer}} - if not set({{{name}}}.keys()).issubset(set(allowed_values)): - raise ValueError( - "Invalid keys in `{{{name}}}` [{0}], must be a subset of [{1}]" - .format(", ".join(map(str, set({{{name}}}.keys())-set(allowed_values))), - ", ".join(map(str, allowed_values))) - ) + # The enum constrains the map values; keys are free-form names. + # A None value means no choice has been made yet. + invalid = {v for v in ({{{name}}} or {}).values() if v is not None} - set(allowed_values) + if invalid: + raise ValueError( + "Invalid values in `{{{name}}}` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, invalid)), + ", ".join(map(str, allowed_values))) + ) {{/isMapContainer}} {{/isContainer}} {{^isContainer}} - allowed_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}, {{/enumVars}}{{/allowableValues}}] - if {{{name}}} not in allowed_values: - raise ValueError( - "Invalid value for `{{{name}}}` ({0}), must be one of {1}" - .format({{{name}}}, allowed_values) - ) + allowed_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}, {{/enumVars}}{{/allowableValues}}] + if {{{name}}} not in allowed_values: + raise ValueError( + "Invalid value for `{{{name}}}` ({0}), must be one of {1}" + .format({{{name}}}, allowed_values) + ) {{/isContainer}} {{/isEnum}} {{^isEnum}} diff --git a/resources/docker/compose.yml b/resources/docker/compose.yml index 0400d5df..cb1c62ee 100644 --- a/resources/docker/compose.yml +++ b/resources/docker/compose.yml @@ -14,6 +14,8 @@ services: - ../certs/nifi.env environment: - AUTH=ldap + # Synthetic provider fixture, never a real credential. + - NIPYAPI_TEST_PROVIDER_SECRET=fixture-secret-value # Provide TLS keystore/truststore for secure.sh - KEYSTORE_PATH=/certs/nifi/keystore.p12 - KEYSTORE_TYPE=PKCS12 @@ -84,6 +86,7 @@ services: - TRUSTSTORE_TYPE=PKCS12 - TRUSTSTORE_PASSWORD=${CERT_PASSWORD:-changeit} - INITIAL_ADMIN_IDENTITY=C=US, O=NiPyAPI, CN=user1 + - NIPYAPI_TEST_PROVIDER_SECRET=fixture-secret-value - NIFI_WEB_PROXY_HOST=localhost:9445,localhost:8443 - NIFI_WEB_HTTPS_PORT=8443 - NIFI_WEB_HTTPS_HOST=0.0.0.0 @@ -133,6 +136,7 @@ services: environment: - SINGLE_USER_CREDENTIALS_USERNAME=einstein - SINGLE_USER_CREDENTIALS_PASSWORD=password1234 + - NIPYAPI_TEST_PROVIDER_SECRET=fixture-secret-value - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 networks: [nipynet] @@ -205,6 +209,7 @@ services: - NIFI_SECURITY_USER_AUTHORIZER=managed-authorizer - NIFI_SECURITY_USER_LOGIN_IDENTITY_PROVIDER= - NIFI_SECURITY_ALLOW_ANONYMOUS_AUTHENTICATION=false + - NIPYAPI_TEST_PROVIDER_SECRET=fixture-secret-value - NIFI_WEB_PROXY_HOST=localhost:9446,localhost:8443 networks: [nipynet] depends_on: @@ -240,6 +245,7 @@ services: environment: - SINGLE_USER_CREDENTIALS_USERNAME=einstein - SINGLE_USER_CREDENTIALS_PASSWORD=password1234 + - NIPYAPI_TEST_PROVIDER_SECRET=fixture-secret-value - NIFI_WEB_PROXY_HOST=localhost:9447,localhost:8443,host.docker.internal:9447 # Provide TLS keystore/truststore with SANs for act testing - KEYSTORE_PATH=/certs/nifi/keystore.p12 diff --git a/resources/scripts/test_distribution.py b/resources/scripts/test_distribution.py index 7904016d..c5d8d57b 100644 --- a/resources/scripts/test_distribution.py +++ b/resources/scripts/test_distribution.py @@ -30,7 +30,15 @@ def validate_distribution(): wheel_file = wheels[0] wheel_name = os.path.basename(wheel_file) - + + # A build without git tags (e.g. a shallow clone) falls back to 0.0.x + # instead of the real release version; refuse to validate it. + wheel_version = wheel_name.split('-')[1] + if wheel_version.startswith('0.0.') or 'unknown' in wheel_version: + print(f"❌ Wheel has a fallback version: {wheel_version}") + print("Build from a checkout with git tags (e.g. fetch-depth: 0 in CI)") + return False + print(f"🧪 Testing distribution: {wheel_name}") with tempfile.TemporaryDirectory() as tmpdir: diff --git a/tests/conftest.py b/tests/conftest.py index d71af9ea..92ba0240 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -215,11 +215,6 @@ def remove_test_parameter_contexts(): """ if SKIP_TEARDOWN: return None - # check_version returns 1 if NiFi is OLDER than specified version, -1 if newer, 0 if equal - # We skip cleanup if NiFi is older than 1.10.0 (doesn't have parameter contexts) - if nipyapi.utils.check_version('1.10.0') > 0: - log.info("NiFi version is older than 1.10, skipping Parameter Context cleanup") - return None # Multiple passes to handle inheritance dependencies max_attempts = 5 @@ -340,6 +335,7 @@ def cleanup_nifi(): remove_test_funnels() remove_test_rpgs() remove_test_parameter_contexts() + remove_test_parameter_providers() def remove_test_rpgs(): if SKIP_TEARDOWN: @@ -388,6 +384,75 @@ def remove_test_controllers(include_reporting_tasks=False): test_basename in li.component.name] +def remove_test_parameter_providers(): + """Remove test providers after their generated contexts have been deleted.""" + if SKIP_TEARDOWN: + return None + handle = nipyapi.nifi.ParameterProvidersApi() + providers = nipyapi.nifi.FlowApi().get_parameter_providers().parameter_providers + for provider in providers: + if provider.component.name.startswith(test_basename + '_param_provider'): + live = handle.get_parameter_provider(provider.id) + handle.remove_parameter_provider(live.id, version=live.revision.version) + return None + + +@pytest.fixture(name='fix_param_provider') +def fixture_parameter_provider(request): + """Create providers restricted to the harmless HOME environment variable.""" + class Dummy: + def generate(self, suffix='', properties=None): + provider_type = next( + item for item in nipyapi.nifi.FlowApi() + .get_parameter_provider_types().parameter_provider_types + if item.type == 'org.apache.nifi.parameter.EnvironmentVariableParameterProvider' + ) + configuration = { + 'parameter-group-name': test_parameter_context_name + '_provider' + suffix, + 'environment-variable-inclusion-strategy': 'comma-separated', + 'include-environment-variables': 'HOME', + } + if properties: + configuration.update(properties) + return nipyapi.nifi.ControllerApi().create_parameter_provider( + nipyapi.nifi.ParameterProviderEntity( + revision=nipyapi.nifi.RevisionDTO(version=0), + component=nipyapi.nifi.ParameterProviderDTO( + name=test_basename + '_param_provider' + suffix, + type=provider_type.type, + bundle=provider_type.bundle, + properties=configuration, + ), + ) + ) + + def cleanup(): + remove_test_parameter_contexts() + remove_test_parameter_providers() + + request.addfinalizer(cleanup) + return Dummy() + + +@pytest.fixture(name='fix_mgmt_cont') +def fixture_management_controller(request): + """Create controller-level services using the shared controller helpers.""" + class Dummy: + def generate(self, suffix=''): + controller_type = nipyapi.canvas.get_controller_type( + 'org.apache.nifi.web.client.provider.service.StandardWebClientServiceProvider', + greedy=False, + ) + return nipyapi.canvas.create_management_controller( + controller_type, name=test_basename + '_mgmt_cont' + suffix + ) + + request.addfinalizer( + functools.partial(remove_test_controllers, include_reporting_tasks=True) + ) + return Dummy() + + def cleanup_reg(): if SKIP_TEARDOWN: log.info("SKIP_TEARDOWN is true; skipping cleanup_reg") diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 90fbb308..45719324 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -148,6 +148,9 @@ def test_create_process_group_invalid_type(): def test_get_process_group(fix_pg): with pytest.raises(AssertionError): _ = canvas.get_process_group('nipyapi_test', 'invalid') + # A missing ID returns None, like get_processor and get_parameter_context. + assert canvas.get_process_group(str(uuid.uuid4()), 'id') is None + assert canvas.get_processor(str(uuid.uuid4()), 'id') is None f_pg = fix_pg.generate() pg1 = canvas.get_process_group(f_pg.id, 'id') assert isinstance(pg1, ProcessGroupEntity) @@ -893,6 +896,38 @@ def test_create_controller(fix_cont): ) +def test_list_all_management_controllers(fix_mgmt_cont, fix_cont): + """Management listing excludes process-group-scoped services.""" + management = fix_mgmt_cont.generate() + grouped = fix_cont() + identifiers = {item.id for item in canvas.list_all_management_controllers()} + assert management.id in identifiers + assert grouped.id not in identifiers + + +def test_get_management_controller(fix_mgmt_cont, fix_cont): + """Management lookup honours scope, matching, and missing-result contracts.""" + first = fix_mgmt_cont.generate('_first') + second = fix_mgmt_cont.generate('_second') + grouped = fix_cont() + assert canvas.get_management_controller(first.id, 'id').id == first.id + assert canvas.get_management_controller(first.component.name, greedy=False).id == first.id + matches = canvas.get_management_controller(conftest.test_basename + '_mgmt_cont') + assert {item.id for item in matches} == {first.id, second.id} + assert canvas.get_management_controller(grouped.id, 'id') is None + assert canvas.get_management_controller(grouped.component.name, greedy=False) is None + assert canvas.get_management_controller('nipyapi_test_missing_mgmt') is None + assert canvas.get_management_controller('nipyapi_test_missing_mgmt', bool_response=True) is None + # A missing ID is an API error: False with bool_response, ValueError otherwise. + assert canvas.get_management_controller(str(uuid.uuid4()), 'id', bool_response=True) is False + with pytest.raises(ValueError): + canvas.get_management_controller(str(uuid.uuid4()), 'id') + duplicate = fix_mgmt_cont.generate('_dup') + fix_mgmt_cont.generate('_dup') + with pytest.raises(ValueError, match='Several controller-level services'): + canvas.ensure_management_controller(duplicate.component.name, _MGMT_CS_TYPE) + + def test_create_management_controller(): cs_type = canvas.get_controller_type( _MGMT_CS_TYPE, identifier_type="name", greedy=False @@ -914,12 +949,18 @@ def test_create_management_controller(): canvas.delete_controller(r1, force=True) -def test_ensure_management_controller(): +def test_ensure_management_controller(fix_pg): name = "test-ensure-mgmt-webclient" props = {"Connect Timeout": "20 secs"} + cs_type = canvas.get_controller_type(_MGMT_CS_TYPE, identifier_type="name", greedy=False) + # A process-group service with the same name must not be adopted. + grouped = canvas.create_controller(fix_pg.generate(), cs_type, name=name) r1 = canvas.ensure_management_controller(name, _MGMT_CS_TYPE, properties=props) try: assert isinstance(r1, nifi.ControllerServiceEntity) + assert r1.id != grouped.id + assert r1.component.parent_group_id is None + assert canvas.get_controller(grouped.id, 'id').component.state == "DISABLED" assert r1.component.name == name assert r1.component.properties["Connect Timeout"] == "20 secs" assert r1.component.state == "ENABLED" @@ -983,6 +1024,9 @@ def test_get_controller(fix_pg, fix_cont): _ = fix_cont(parent_pg=f_pg, kind='CSVReader') r3 = canvas.get_controller('CSVReader') assert len(r3) == 2 + # bool_response only changes API errors: a missing ID returns False, a missing name None. + assert canvas.get_controller(str(uuid.uuid4()), 'id', bool_response=True) is False + assert canvas.get_controller('nipyapi_test_missing_controller', bool_response=True) is None def test_schedule_controller(fix_pg, fix_cont): @@ -1477,8 +1521,47 @@ def test_remote_process_group_controls(fix_proc): # ============================================================================= -def test_verify_controller_disabled(fix_pg, fix_cont): +@pytest.mark.parametrize('kind', ['controller', 'processor']) +def test_verification_request_failure(fix_pg, fix_cont, fix_proc, monkeypatch, kind): + """A completed failed verification request raises NiFi's reason and is deleted. + + NiFi marks a failed request complete with failure_reason; no reliable live + trigger exists, so the request boundary is simulated. Live completion, + FAILED result rows and deletion are covered by the real verification tests. + """ + group = fix_pg.generate() + component = fix_cont(parent_pg=group) if kind == 'controller' else fix_proc.generate(parent_pg=group) + api = nifi.ControllerServicesApi if kind == 'controller' else nifi.ProcessorsApi + deleted = [] + suffix = '' if kind == 'controller' else '2' + monkeypatch.setattr( + api, 'submit_config_verification_request' if kind == 'controller' + else 'submit_processor_verification_request', + lambda *args, **kwargs: nifi.VerifyConfigRequestEntity( + request=nifi.VerifyConfigRequestDTO(request_id='verify-request'))) + monkeypatch.setattr(api, 'get_verification_request' + suffix, lambda *args, **kwargs: + nifi.VerifyConfigRequestEntity(request=nifi.VerifyConfigRequestDTO( + complete=True, failure_reason='verification failed'))) + monkeypatch.setattr(api, 'delete_verification_request' + suffix, + lambda self, id, request_id: deleted.append((id, request_id))) + invoke = canvas.verify_controller if kind == 'controller' else canvas.verify_processor + with pytest.raises(ValueError, match='^verification failed$'): + invoke(component) + assert deleted == [(component.id, 'verify-request')] + + +def test_verify_controller_disabled(fix_pg, fix_cont, monkeypatch): """Test verifying a disabled controller service configuration.""" + api = nifi.ControllerServicesApi + original_delete = api.delete_verification_request + deleted = [] + + def record_delete(handle, id, request_id, **kwargs): + deleted.append((id, request_id)) + return original_delete(handle, id=id, request_id=request_id, **kwargs) + + # Pass-through spy: the real NiFi DELETE runs; only its IDs are recorded. + monkeypatch.setattr(api, 'delete_verification_request', record_delete) f_pg = fix_pg.generate() f_c1 = fix_cont(parent_pg=f_pg) @@ -1494,6 +1577,10 @@ def test_verify_controller_disabled(fix_pg, fix_cont): assert hasattr(r, 'verification_step_name') assert hasattr(r, 'outcome') assert r.outcome in ('SUCCESSFUL', 'FAILED', 'SKIPPED') + assert len(deleted) == 1 + with pytest.raises(nifi.rest.ApiException) as gone: + api().get_verification_request(*deleted[0]) + assert gone.value.status == 404 def test_verify_controller_by_id(fix_pg, fix_cont): diff --git a/tests/test_ci.py b/tests/test_ci.py index a64d497b..b9908372 100644 --- a/tests/test_ci.py +++ b/tests/test_ci.py @@ -581,9 +581,8 @@ def test_cleanup(fix_pg): assert result["deleted"] == "true" assert result["process_group_name"] == "test_ci_cleanup_target" - # Verify it's gone - get_process_group raises ValueError for missing PG - with pytest.raises(ValueError, match="Unable to locate"): - nipyapi.canvas.get_process_group(pg.id, "id") + # Verify it's gone - get_process_group returns None for a missing ID + assert nipyapi.canvas.get_process_group(pg.id, "id") is None def test_cleanup_with_orphaned_contexts(): @@ -730,7 +729,7 @@ def test_configure_params_non_dict(): def test_configure_params_json_embedded_quotes(): """Test configure_params accepts JSON with embedded quotes.""" # Should fail on PG lookup, not on JSON parsing - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"message": "value with \\"quotes\\""}' @@ -739,7 +738,7 @@ def test_configure_params_json_embedded_quotes(): def test_configure_params_json_newlines(): """Test configure_params accepts JSON with escaped newlines.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"multiline": "line1\\nline2"}' @@ -748,7 +747,7 @@ def test_configure_params_json_newlines(): def test_configure_params_json_backslashes(): """Test configure_params accepts JSON with backslashes (Windows paths).""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"path": "C:\\\\Users\\\\data"}' @@ -757,7 +756,7 @@ def test_configure_params_json_backslashes(): def test_configure_params_json_nested_dict(): """Test configure_params accepts JSON with nested dict values.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"config": {"nested": "value"}}' @@ -766,7 +765,7 @@ def test_configure_params_json_nested_dict(): def test_configure_params_json_list_value(): """Test configure_params accepts JSON with list values.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"items": ["a", "b", "c"]}' @@ -775,7 +774,7 @@ def test_configure_params_json_list_value(): def test_configure_params_json_null_value(): """Test configure_params accepts JSON with null values.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"optional": null}' @@ -784,7 +783,7 @@ def test_configure_params_json_null_value(): def test_configure_params_json_empty_string(): """Test configure_params accepts JSON with empty string values.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"empty": ""}' @@ -793,7 +792,7 @@ def test_configure_params_json_empty_string(): def test_configure_params_json_unicode(): """Test configure_params accepts JSON with Unicode characters.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"greeting": "Hello \\u4e16\\u754c"}' @@ -802,7 +801,7 @@ def test_configure_params_json_unicode(): def test_configure_params_json_special_key_chars(): """Test configure_params accepts JSON with special chars in keys.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"my-key": "value1", "my.key": "value2"}' @@ -811,7 +810,7 @@ def test_configure_params_json_special_key_chars(): def test_configure_params_json_mixed_types(): """Test configure_params accepts JSON with mixed value types.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters='{"str": "text", "int": 42, "float": 3.14, "bool": true}' @@ -820,7 +819,7 @@ def test_configure_params_json_mixed_types(): def test_configure_params_dict_input(): """Test configure_params accepts dict input directly (not JSON string).""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters={"key": "value", "nested": {"deep": "data"}} @@ -829,7 +828,7 @@ def test_configure_params_dict_input(): def test_configure_params_dict_with_complex_values(): """Test configure_params accepts dict with complex nested values.""" - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_params( process_group_id="nonexistent-pg-id", parameters={ @@ -950,7 +949,7 @@ def test_configure_inherited_params_non_dict(): def test_configure_inherited_params_pg_not_found(): """Test configure_inherited_params with non-existent PG raises error.""" import uuid - with pytest.raises(ValueError, match="Unable to locate group"): + with pytest.raises(ValueError, match="Process group not found"): ci.configure_inherited_params( process_group_id=str(uuid.uuid4()), parameters='{"key": "value"}' @@ -971,10 +970,6 @@ def test_configure_inherited_params_no_context(fix_pg): def test_configure_inherited_params_dry_run(fix_pg, fix_context): """Test configure_inherited_params dry run mode.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -1012,10 +1007,6 @@ def test_configure_inherited_params_dry_run(fix_pg, fix_context): def test_configure_inherited_params_execute(fix_pg, fix_context): """Test configure_inherited_params actually updates parameter.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -1053,10 +1044,6 @@ def test_configure_inherited_params_execute(fix_pg, fix_context): def test_configure_inherited_params_empty_string(fix_pg, fix_context): """Test configure_inherited_params sets empty string correctly.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter that has a value ctx = fix_context.generate() @@ -1093,10 +1080,6 @@ def test_configure_inherited_params_empty_string(fix_pg, fix_context): def test_configure_inherited_params_none_unsets_value(fix_pg, fix_context): """Test configure_inherited_params with None unsets the parameter value.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter that has a value ctx = fix_context.generate() @@ -1134,10 +1117,6 @@ def test_configure_inherited_params_none_unsets_value(fix_pg, fix_context): def test_configure_inherited_params_not_found_error(fix_pg, fix_context): """Test configure_inherited_params with non-existent parameter.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create empty context ctx = fix_context.generate() @@ -1163,10 +1142,6 @@ def test_configure_inherited_params_not_found_error(fix_pg, fix_context): def test_configure_inherited_params_allow_override(fix_pg, fix_context): """Test configure_inherited_params with allow_override creates new param.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create empty context ctx = fix_context.generate() @@ -1202,10 +1177,6 @@ def test_configure_inherited_params_allow_override(fix_pg, fix_context): def test_upload_asset_from_file_path(fix_context, tmp_path): """Test ci.upload_asset from local file path.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -1231,10 +1202,6 @@ def test_upload_asset_from_file_path(fix_context, tmp_path): def test_upload_asset_from_process_group(fix_pg, fix_context, tmp_path): """Test ci.upload_asset resolves context from process group.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context and attach to PG ctx = fix_context.generate() @@ -1261,10 +1228,6 @@ def test_upload_asset_from_process_group(fix_pg, fix_context, tmp_path): def test_upload_asset_with_param_link(fix_context, tmp_path): """Test ci.upload_asset with parameter linking.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -1301,10 +1264,6 @@ def test_upload_asset_with_param_link(fix_context, tmp_path): def test_upload_asset_custom_filename(fix_context, tmp_path): """Test ci.upload_asset with custom filename override.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -1327,10 +1286,6 @@ def test_upload_asset_custom_filename(fix_context, tmp_path): def test_upload_asset_file_not_found(fix_context): """Test ci.upload_asset with non-existent file raises error.""" - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -1344,10 +1299,6 @@ def test_upload_asset_file_not_found(fix_context): def test_upload_asset_invalid_context(): """Test ci.upload_asset with invalid context_id raises error.""" import uuid - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") with pytest.raises(ValueError, match="Parameter context not found"): ci.upload_asset( @@ -2098,10 +2049,6 @@ def test_export_parameters_no_context(fix_pg): def test_export_parameters_simple_json(fix_pg, fix_context): """Test export_parameters with simple single context (JSON format).""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -2133,10 +2080,6 @@ def test_export_parameters_simple_json(fix_pg, fix_context): def test_export_parameters_yaml_format(fix_pg, fix_context): """Test export_parameters with YAML format.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -2164,10 +2107,6 @@ def test_export_parameters_yaml_format(fix_pg, fix_context): def test_export_parameters_to_file(fix_pg, fix_context, tmp_path): """Test export_parameters writes to file.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() param = nipyapi.parameters.prepare_parameter( @@ -2198,10 +2137,6 @@ def test_export_parameters_to_file(fix_pg, fix_context, tmp_path): def test_export_parameters_with_hierarchy(fix_inherited_context_hierarchy): """Test export_parameters with include_hierarchy flag.""" - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") fixture = fix_inherited_context_hierarchy pg = fixture.pg @@ -2233,10 +2168,6 @@ def test_export_parameters_with_hierarchy(fix_inherited_context_hierarchy): def test_export_parameters_flat_with_inherited(fix_inherited_context_hierarchy): """Test flat export includes parameters from all contexts in hierarchy.""" - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") fixture = fix_inherited_context_hierarchy pg = fixture.pg @@ -2260,10 +2191,6 @@ def test_export_parameters_flat_with_inherited(fix_inherited_context_hierarchy): def test_configure_inherited_params_from_file(fix_pg, fix_context, tmp_path): """Test configure_inherited_params reads parameters from file.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -2304,10 +2231,6 @@ def test_configure_inherited_params_from_file(fix_pg, fix_context, tmp_path): def test_configure_inherited_params_from_yaml_file(fix_pg, fix_context, tmp_path): """Test configure_inherited_params reads parameters from YAML file.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter ctx = fix_context.generate() @@ -2341,10 +2264,6 @@ def test_configure_inherited_params_from_yaml_file(fix_pg, fix_context, tmp_path def test_configure_inherited_params_both_sources_error(fix_pg, fix_context, tmp_path): """Test providing both parameters and parameters_file raises error.""" - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() pg = fix_pg.generate() @@ -2379,10 +2298,6 @@ def test_configure_inherited_params_file_not_found(): def test_export_import_roundtrip_simple(fix_pg, fix_context, tmp_path): """Test exporting parameters and importing them back (simple case).""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with parameters ctx = fix_context.generate() @@ -2434,10 +2349,6 @@ def test_export_import_roundtrip_simple(fix_pg, fix_context, tmp_path): def test_export_import_roundtrip_with_inheritance(fix_inherited_context_hierarchy, tmp_path): """Test exporting and importing with inherited contexts.""" import nipyapi - from nipyapi.utils import check_version - - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") fixture = fix_inherited_context_hierarchy pg = fixture.pg diff --git a/tests/test_generated_models.py b/tests/test_generated_models.py new file mode 100644 index 00000000..3fffcb4a --- /dev/null +++ b/tests/test_generated_models.py @@ -0,0 +1,131 @@ +"""Tests for client-side validation in the generated NiFi API models. + +These exercise the swagger templates and spec augmentations that produce +``nipyapi.nifi.models`` rather than any maintained nipyapi function, so +they construct and deserialize models directly without touching NiFi. +""" + +import pytest + +import nipyapi +from nipyapi.nifi import ApiClient +from nipyapi.nifi.models import ( + AffectedComponentEntity, + ParameterGroupConfigurationEntity, + ParameterProviderEntity, +) + + +# Shape of a Parameter Provider entity as returned by a fetch request. +# On the first fetch of a new group NiFi stages each parameter with a null +# sensitivity and a null synchronized flag; later fetches return the +# sensitivity that was applied. +FIRST_FETCH_PROVIDER = { + "id": "00000000-0000-0000-0000-000000000001", + "revision": {"version": 1}, + "component": { + "id": "00000000-0000-0000-0000-000000000001", + "name": "Example Parameter Provider", + "type": "org.example.ExampleParameterProvider", + "parameterGroupConfigurations": [ + { + "groupName": "example.secrets", + "parameterContextName": "example.secrets", + "parameterSensitivities": {"API_KEY": None}, + "synchronized": None, + } + ], + }, +} + +LATER_FETCH_PROVIDER = { + "id": "00000000-0000-0000-0000-000000000001", + "revision": {"version": 2}, + "component": { + "id": "00000000-0000-0000-0000-000000000001", + "name": "Example Parameter Provider", + "type": "org.example.ExampleParameterProvider", + "parameterGroupConfigurations": [ + { + "groupName": "example.secrets", + "parameterContextName": "example.secrets", + "parameterSensitivities": { + "API_KEY": "SENSITIVE", + "API_HOST": "NON_SENSITIVE", + }, + "synchronized": True, + } + ], + }, +} + + +def test_parameter_sensitivities_keyed_by_parameter_name(): + # Keys are parameter names; only the values are constrained by the enum + group = ParameterGroupConfigurationEntity( + group_name="example.secrets", + parameter_sensitivities={"API_KEY": "SENSITIVE", "API_HOST": "NON_SENSITIVE"}, + ) + assert group.parameter_sensitivities == { + "API_KEY": "SENSITIVE", + "API_HOST": "NON_SENSITIVE", + } + + +def test_parameter_sensitivities_allows_unset_value(): + # A first fetch stages parameters with no sensitivity chosen yet + group = ParameterGroupConfigurationEntity( + group_name="example.secrets", + parameter_sensitivities={"API_KEY": None}, + ) + assert group.parameter_sensitivities == {"API_KEY": None} + + +def test_parameter_sensitivities_rejects_invalid_value(): + with pytest.raises(ValueError): + ParameterGroupConfigurationEntity( + group_name="example.secrets", + parameter_sensitivities={"API_KEY": "SECRET"}, + ) + + +@pytest.mark.parametrize("payload", [FIRST_FETCH_PROVIDER, LATER_FETCH_PROVIDER]) +def test_deserialize_parameter_provider_fetch_response(payload): + entity = ApiClient().deserialize_model(payload, ParameterProviderEntity) + groups = entity.component.parameter_group_configurations + assert len(groups) == 1 + assert groups[0].group_name == "example.secrets" + assert set(groups[0].parameter_sensitivities) >= {"API_KEY"} + + +def test_client_side_validation_can_be_disabled(monkeypatch): + monkeypatch.setattr( + nipyapi.config.nifi_config, "client_side_validation", False + ) + group = ParameterGroupConfigurationEntity( + group_name="example.secrets", + parameter_sensitivities={"API_KEY": "SECRET"}, + ) + assert group.parameter_sensitivities == {"API_KEY": "SECRET"} + entity = AffectedComponentEntity(reference_type="NOT_A_TYPE") + assert entity.reference_type == "NOT_A_TYPE" + + +def test_client_side_validation_enabled_by_default(): + assert getattr(nipyapi.config.nifi_config, "client_side_validation", None) is True + with pytest.raises(ValueError): + AffectedComponentEntity(reference_type="NOT_A_TYPE") + + +@pytest.mark.parametrize("client", [nipyapi.nifi, nipyapi.registry]) +def test_enum_validation_scalar_and_container(client, monkeypatch): + """The shared template guard covers both clients and list enums.""" + configuration = client.Configuration() + assert configuration.client_side_validation is True + with pytest.raises(ValueError): + client.Stateful(scopes=['UNRECOGNIZED']) + with pytest.raises(ValueError): + client.DynamicProperty(expression_language_scope='UNRECOGNIZED') + monkeypatch.setattr(configuration, 'client_side_validation', False) + assert client.Stateful(scopes=['UNRECOGNIZED']).scopes == ['UNRECOGNIZED'] + assert client.DynamicProperty(expression_language_scope='UNRECOGNIZED').expression_language_scope == 'UNRECOGNIZED' diff --git a/tests/test_parameters.py b/tests/test_parameters.py index 3b7b8c4d..c4e3be34 100644 --- a/tests/test_parameters.py +++ b/tests/test_parameters.py @@ -6,12 +6,553 @@ from nipyapi import parameters from nipyapi.nifi import ParameterContextEntity from nipyapi.nifi.rest import ApiException -from nipyapi.utils import check_version + + +def test_list_all_parameter_providers(fix_param_provider): + """Provider listing returns the created entities.""" + provider = fix_param_provider.generate() + assert provider.id in {item.id for item in parameters.list_all_parameter_providers()} + + +def test_get_parameter_provider(fix_param_provider): + """Provider lookup supports id/name/type and None/single/list results.""" + first = fix_param_provider.generate('_first') + second = fix_param_provider.generate('_second') + assert parameters.get_parameter_provider(first.id, 'id').id == first.id + assert parameters.get_parameter_provider(first.component.name, greedy=False).id == first.id + matches = parameters.get_parameter_provider(conftest.test_basename + '_param_provider') + assert {item.id for item in matches} == {first.id, second.id} + typed = parameters.get_parameter_provider('EnvironmentVariableParameterProvider', 'type') + assert {first.id, second.id}.issubset({item.id for item in typed}) + assert parameters.get_parameter_provider('nipyapi_test_missing_provider') is None + assert parameters.get_parameter_provider(str(uuid.uuid4()), 'id') is None + + +def test_list_all_parameter_provider_types(): + """Provider type discovery includes the stock environment provider.""" + types = parameters.list_all_parameter_provider_types() + assert any(item.type.endswith('.EnvironmentVariableParameterProvider') for item in types) + + +def test_get_parameter_provider_type(): + """Provider type lookup follows the existing documented-type filter contract.""" + provider_type = parameters.get_parameter_provider_type('EnvironmentVariableParameterProvider') + assert provider_type.type == 'org.apache.nifi.parameter.EnvironmentVariableParameterProvider' + assert parameters.get_parameter_provider_type(provider_type.type, greedy=False) == provider_type + assert parameters.get_parameter_provider_type('nipyapi_test_missing_type') is None + assert len(parameters.get_parameter_provider_type('ParameterProvider')) > 1 + + +def test_provider_stale_revision(fix_param_provider): + """refresh exists because NiFi rejects a stale provider revision.""" + provider = fix_param_provider.generate() + stale = parameters.get_parameter_provider(provider.id, 'id') + parameters.update_parameter_provider(provider, {'include-environment-variables': 'HOME'}) + for operation in ( + lambda **kwargs: parameters.update_parameter_provider( + stale, {'include-environment-variables': 'HOME'}, **kwargs), + lambda **kwargs: parameters.fetch_parameter_provider(stale, **kwargs), + ): + with pytest.raises(ApiException) as rejected: + operation(refresh=False) + assert rejected.value.status in (400, 409) + assert 'up-to-date' in rejected.value.body + assert operation().id == provider.id + +def test_update_parameter_provider(fix_param_provider): + """Provider updates refresh stale revisions and validate property keys.""" + provider = fix_param_provider.generate() + properties = {'parameter-group-name': conftest.test_parameter_context_name + '_changed'} + updated = parameters.update_parameter_provider(provider, properties) + assert updated.component.properties['parameter-group-name'] == properties['parameter-group-name'] + cleared = parameters.update_parameter_provider(provider, {'include-environment-variables': None}) + assert cleared.component.properties['include-environment-variables'] is None + with pytest.raises(ValueError, match='property'): + parameters.update_parameter_provider(provider, {'not-a-property': 'unused'}) + + +def test_fetch_parameter_provider(fix_param_provider): + """Fetch stages only the configured group and refreshes the provider revision.""" + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider.id) + assert fetched.id == provider.id + group = fetched.component.parameter_group_configurations[0] + assert group.group_name == provider.component.properties['parameter-group-name'] + assert set(group.parameter_sensitivities) == {'HOME'} + assert parameters.fetch_parameter_provider(provider).id == provider.id + + +def test_apply_parameter_provider(fix_param_provider): + """First apply assigns explicit sensitivities and returns a completed request.""" + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + group_name = provider.component.properties['parameter-group-name'] + request = parameters.apply_parameter_provider(provider, [group_name], fetch_result=fetched) + assert request.complete and not request.failure_reason + context = parameters.get_parameter_context(group_name, greedy=False) + home = next(item.parameter for item in context.component.parameters if item.parameter.name == 'HOME') + assert home.sensitive is True + assert home.value in (None, '********') + with pytest.raises(ApiException) as deleted: + conftest.nipyapi.nifi.ParameterProvidersApi().get_parameter_provider_apply_parameters_request( + provider.id, request.request_id + ) + assert deleted.value.status == 404 + with pytest.raises(ValueError, match='missing'): + parameters.apply_parameter_provider(provider, ['missing']) + + +def test_fetch_and_apply_parameter_provider(fix_param_provider): + """Fetch and apply by ID supports repeat refresh and rejects empty requested groups.""" + provider = fix_param_provider.generate() + request = parameters.fetch_and_apply_parameter_provider(provider.id, identifier_type='id') + assert request.complete and not request.failure_reason + repeated = parameters.fetch_and_apply_parameter_provider(provider) + assert not repeated.referencing_components + parameters.update_parameter_provider(provider, {'include-environment-variables': 'NIPYAPI_ABSENT_VARIABLE'}) + with pytest.raises(ValueError, match='empty|parameters'): + parameters.fetch_and_apply_parameter_provider(provider) + parameters.update_parameter_provider(provider, {'include-environment-variables': 'HOME'}) + # Overrides reach apply, so a mistyped name is rejected before anything is submitted. + with pytest.raises(ValueError, match='Unknown parameters'): + parameters.fetch_and_apply_parameter_provider( + provider, sensitivities={'NIPYAPI_TYPO': 'SENSITIVE'}) + with pytest.raises(TypeError, match='synchronized'): + parameters.fetch_and_apply_parameter_provider(provider, synchronized='yes') + + +def test_set_inherited_parameter_contexts(fix_context, fix_inherited_context_hierarchy): + """Prepend controls actual inherited precedence; replace preserves locals.""" + hierarchy = fix_inherited_context_hierarchy + first = fix_context.generate(conftest.test_parameter_context_name + '_first') + parameters.upsert_parameter_to_context( + first, parameters.prepare_parameter(hierarchy.child_param_name, 'first_value')) + second = hierarchy.child_ctx + target = hierarchy.parent_ctx + request = parameters.set_inherited_parameter_contexts(target, [second], mode='replace') + assert request.complete and not request.failure_reason + with pytest.raises(ApiException) as deleted: + conftest.nipyapi.nifi.ParameterContextsApi().get_parameter_context_update( + target.id, request.request_id) + assert deleted.value.status == 404 + parameters.set_inherited_parameter_contexts(target.id, [first, second], mode='prepend') + repeated = parameters.set_inherited_parameter_contexts(target, [first], mode='prepend') + live = conftest.nipyapi.nifi.ParameterContextsApi().get_parameter_context( + target.id, include_inherited_parameters=True) + assert [item.id for item in live.component.inherited_parameter_contexts] == [first.id, second.id] + assert not repeated.referencing_components + assert next(item.parameter.value for item in live.component.parameters + if item.parameter.name == hierarchy.child_param_name) == 'first_value' + parameters.set_inherited_parameter_contexts(target, [], mode='replace') + live = parameters.get_parameter_context(target.id, 'id') + assert not live.component.inherited_parameter_contexts + assert [(item.parameter.name, item.parameter.value) for item in live.component.parameters] == [ + (hierarchy.parent_param_name, 'parent_value'), + ] + + +def test_inheritance_uses_live_context(fix_inherited_context_hierarchy, fix_context): + """A stale context entity cannot drop inheritance added after it was read.""" + hierarchy = fix_inherited_context_hierarchy + target = hierarchy.parent_ctx + stale = parameters.get_parameter_context(target.id, 'id') + added = fix_context.generate(conftest.test_parameter_context_name + '_added') + parameters.set_inherited_parameter_contexts(target, [added]) + later = fix_context.generate(conftest.test_parameter_context_name + '_later') + parameters.set_inherited_parameter_contexts(stale, [later]) + live = parameters.get_parameter_context(target.id, 'id') + assert [item.id for item in live.component.inherited_parameter_contexts] == [ + later.id, added.id, hierarchy.child_ctx.id] + +def test_connect_uses_live_target(fix_context, fix_pg): + """Stale context and process-group entities resolve to the current target.""" + source = fix_context.generate(conftest.test_parameter_context_name + '_live_source') + parameters.upsert_parameter_to_context(source, parameters.prepare_parameter('KEY', 'value', sensitive=True)) + target = fix_context.generate(conftest.test_parameter_context_name + '_live_target') + stale_target = parameters.get_parameter_context(target.id, 'id') + group = fix_pg.generate() + parameters.assign_context_to_process_group(group, target.id) + other = fix_context.generate(conftest.test_parameter_context_name + '_live_other') + parameters.set_inherited_parameter_contexts(target, [other]) + parameters.connect_parameter_provider_group(group, source.component.name, {'Alias': 'KEY'}) + parameters.connect_parameter_provider_group(stale_target, source.component.name, {'Alias': 'KEY'}) + live = parameters.get_parameter_context(target.id, 'id') + assert [item.id for item in live.component.inherited_parameter_contexts] == [source.id, other.id] + +def test_get_process_group_parameter_context(fix_pg, fix_context): + """Bound-context discovery accepts entities and strings; unbound returns None.""" + group = fix_pg.generate() + assert parameters.get_process_group_parameter_context(group) is None + context = fix_context.generate() + parameters.assign_context_to_process_group(group, context.id) + assert parameters.get_process_group_parameter_context(group).id == context.id + assert parameters.get_process_group_parameter_context(group.id).id == context.id + + +def test_connect_parameter_provider_group(fix_context, fix_pg): + """Connect prepends the supplied context and creates a local sensitive alias.""" + source = fix_context.generate(conftest.test_parameter_context_name + '_source') + parameters.upsert_parameter_to_context( + source, parameters.prepare_parameter('API_KEY', 'fixture-secret-value', sensitive=True) + ) + target = fix_context.generate(conftest.test_parameter_context_name + '_target') + group = fix_pg.generate() + parameters.assign_context_to_process_group(group, target.id) + request = parameters.connect_parameter_provider_group( + group, source.component.name, {'Local Secret': 'API_KEY'} + ) + assert request.complete and not request.failure_reason + live = parameters.get_parameter_context(target.id, 'id') + assert live.component.inherited_parameter_contexts[0].id == source.id + alias = next(item.parameter for item in live.component.parameters if item.parameter.name == 'Local Secret') + assert alias.sensitive is True + repeated = parameters.connect_parameter_provider_group( + target.id, source.component.name, {'Local Secret': 'API_KEY'} + ) + assert not repeated.referencing_components + # An already-inherited source keeps its position unless a higher context shadows it. + other = fix_context.generate(conftest.test_parameter_context_name + '_other') + parameters.set_inherited_parameter_contexts(target, [other, source], mode='replace') + parameters.connect_parameter_provider_group(target, source.component.name, {'Local Secret': 'API_KEY'}) + live = parameters.get_parameter_context(target.id, 'id') + assert [item.id for item in live.component.inherited_parameter_contexts] == [other.id, source.id] + parameters.upsert_parameter_to_context( + other, parameters.prepare_parameter('API_KEY', 'shadow', sensitive=True)) + with pytest.raises(ValueError, match=r"shadow.*\['API_KEY'\]"): + parameters.connect_parameter_provider_group( + target, source.component.name, {'Local Secret': 'API_KEY'}) + with pytest.raises(ValueError, match='MISSING'): + parameters.connect_parameter_provider_group(target, source.component.name, {'Local Secret': 'MISSING'}) + + +def test_provider_sensitivity_precedence(fix_param_provider): + """Explicit overrides beat staged choices, which beat the default.""" + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + group = fetched.component.parameter_group_configurations[0] + group.parameter_sensitivities = {'HOME': 'NON_SENSITIVE'} + parameters.apply_parameter_provider( + provider, sensitivities={'HOME': 'SENSITIVE'}, fetch_result=fetched, + ) + context = parameters.get_parameter_context(group.group_name, greedy=False) + assert next(item.parameter for item in context.component.parameters + if item.parameter.name == 'HOME').sensitive is True + # A new default must not override the stored sensitivity on subsequent fetches. + repeated = parameters.fetch_and_apply_parameter_provider(provider, sensitivity='NON_SENSITIVE') + assert repeated.complete and not repeated.failure_reason + context = parameters.get_parameter_context(group.group_name, greedy=False) + assert next(item.parameter for item in context.component.parameters + if item.parameter.name == 'HOME').sensitive is True + + +def test_apply_parameter_provider_request_failure(fix_param_provider, monkeypatch): + """A completed failed apply raises NiFi's reason and deletes that request. + + NiFi marks a failed request complete with failure_reason; no reliable live + trigger exists, so the request boundary is simulated. Cleanup policy itself + is covered by tests/test_utils.py. + """ + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + nifi = conftest.nipyapi.nifi + deleted = [] + monkeypatch.setattr(nifi.ParameterProvidersApi, 'submit_apply_parameters', + lambda *args, **kwargs: nifi.ParameterProviderApplyParametersRequestEntity( + request=nifi.ParameterProviderApplyParametersRequestDTO(request_id='test-request'))) + monkeypatch.setattr(nifi.ParameterProvidersApi, 'get_parameter_provider_apply_parameters_request', + lambda *args: nifi.ParameterProviderApplyParametersRequestEntity( + request=nifi.ParameterProviderApplyParametersRequestDTO( + complete=True, failure_reason='provider request failed: source unavailable'))) + monkeypatch.setattr(nifi.ParameterProvidersApi, 'delete_apply_parameters_request', + lambda self, provider_id, request_id: deleted.append((provider_id, request_id))) + with pytest.raises(ValueError, match='^provider request failed: source unavailable$'): + parameters.apply_parameter_provider(provider, fetch_result=fetched) + assert deleted == [(provider.id, 'test-request')] + + +def test_provider_fetch_failure_hint(fix_param_provider, monkeypatch, caplog): + """Fetch preserves the REST error details and logs the additional scope hint.""" + import logging + import urllib3 + provider = fix_param_provider.generate() + original_request = urllib3.PoolManager.request + def failed_fetch(pool, method, url, **kwargs): + if method == 'POST' and url.endswith('/fetch-requests'): + return urllib3.response.HTTPResponse( + status=500, reason='Internal Server Error', + body=b'Provider source unavailable', headers={'X-Request-Id': 'fetch-test'}, + ) + return original_request(pool, method, url, **kwargs) + monkeypatch.setattr(urllib3.PoolManager, 'request', failed_fetch) + with caplog.at_level(logging.DEBUG), pytest.raises(ApiException) as failed: + parameters.fetch_parameter_provider(provider) + assert failed.value.status == 500 + assert failed.value.reason == 'Internal Server Error' + assert failed.value.body == 'Provider source unavailable' + assert failed.value.headers['X-Request-Id'] == 'fetch-test' + assert 'Provider source unavailable' in caplog.text + assert 'scope' in caplog.text + + +def test_parameter_helpers_do_not_expose_secrets(fix_param_provider, fix_context, caplog): + """Sensitive context values stay absent from returned models and DEBUG logs.""" + import logging + target = fix_context.generate(conftest.test_parameter_context_name + '_secret_target') + # This synthetic value originates in the provider, not a separate context. + provider = fix_param_provider.generate(properties={ + 'include-environment-variables': 'NIPYAPI_TEST_PROVIDER_SECRET', + }) + caplog.clear() + with caplog.at_level(logging.DEBUG): + fetched = parameters.fetch_parameter_provider(provider) + applied = parameters.apply_parameter_provider(provider, fetch_result=fetched) + refreshed = parameters.fetch_and_apply_parameter_provider(provider) + source = parameters.get_parameter_context( + provider.component.properties['parameter-group-name'], greedy=False) + assert {item.parameter.name for item in source.component.parameters} == {'NIPYAPI_TEST_PROVIDER_SECRET'} + assert all(item.parameter.sensitive is True and item.parameter.value in (None, '********') + for item in source.component.parameters) + inherited = parameters.set_inherited_parameter_contexts(target, [source]) + connected = parameters.connect_parameter_provider_group( + target, source.component.name, {'Local Secret': 'NIPYAPI_TEST_PROVIDER_SECRET'} + ) + for result in [fetched, applied, refreshed, source, inherited, connected]: + assert 'fixture-secret-value' not in repr(result.to_dict()) + assert 'fixture-secret-value' not in caplog.text + + +@pytest.mark.parametrize('entrypoint', ['update', 'inherit']) +def test_context_request_failure_cleanup(fix_context, monkeypatch, entrypoint): + """Both context APIs raise a completed request failure and delete the request. + + NiFi marks a failed request complete with failure_reason; no reliable live + trigger exists, so the request boundary is simulated. Live success and + deletion are covered by the real update tests. + """ + context = fix_context.generate() + nifi = conftest.nipyapi.nifi + deleted = [] + + def invoke(): + if entrypoint == 'update': + return parameters.update_parameter_context(context) + return parameters.set_inherited_parameter_contexts(context, [], mode='replace') + monkeypatch.setattr(nifi.ParameterContextsApi, 'submit_parameter_context_update', + lambda *args, **kwargs: nifi.ParameterContextUpdateRequestEntity( + request=nifi.ParameterContextUpdateRequestDTO(request_id='context-request'))) + monkeypatch.setattr(nifi.ParameterContextsApi, 'get_parameter_context_update', + lambda *args: nifi.ParameterContextUpdateRequestEntity( + request=nifi.ParameterContextUpdateRequestDTO( + complete=True, failure_reason='context update failed'))) + monkeypatch.setattr(nifi.ParameterContextsApi, 'delete_update_request', + lambda self, context_id, request_id: deleted.append((context_id, request_id))) + with pytest.raises(ValueError, match='^context update failed$'): + invoke() + assert deleted == [(context.id, 'context-request')] + + +@pytest.mark.parametrize('entrypoint', ['update', 'inherit']) +def test_context_inheritance_cycle_conflict(fix_context, entrypoint): + """NiFi rejects a circular inheritance at submit; the 409 propagates unchanged.""" + first = fix_context.generate(conftest.test_parameter_context_name + '_cycle_a') + second = fix_context.generate(conftest.test_parameter_context_name + '_cycle_b') + parameters.set_inherited_parameter_contexts(second, [first]) + try: + with pytest.raises(ApiException) as failed: + if entrypoint == 'update': + first.component.inherited_parameter_contexts = [ + ParameterContextEntity(id=second.id, component=conftest.nipyapi.nifi + .ParameterContextDTO(id=second.id))] + parameters.update_parameter_context(first) + else: + parameters.set_inherited_parameter_contexts(first, [second]) + assert failed.value.status == 409 + assert 'Circular' in failed.value.body + finally: + parameters.set_inherited_parameter_contexts(second, [], mode='replace') + + +def test_parameter_helper_argument_validation(fix_param_provider, fix_context): + """Invalid arguments are rejected before anything is submitted.""" + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + group = fetched.component.parameter_group_configurations[0].group_name + with pytest.raises(TypeError, match='properties'): + parameters.update_parameter_provider(provider, 'HOME') + with pytest.raises(ValueError, match='sensitivity must'): + parameters.apply_parameter_provider(provider, sensitivity='SECRET') + with pytest.raises(TypeError, match='sensitivities must'): + parameters.apply_parameter_provider(provider, sensitivities='HOME') + with pytest.raises(ValueError, match='sensitivities must'): + parameters.apply_parameter_provider(provider, sensitivities={'HOME': 'SECRET'}) + with pytest.raises(TypeError, match='group_names'): + parameters.apply_parameter_provider(provider, [1], fetch_result=fetched) + other = fix_param_provider.generate(suffix='_other') + with pytest.raises(ValueError, match='fetch_result'): + parameters.apply_parameter_provider(other, fetch_result=fetched) + # A single group name is accepted as well as a list. + assert parameters.apply_parameter_provider(provider, group, fetch_result=fetched).complete + context = fix_context.generate() + parameters.upsert_parameter_to_context(context, parameters.prepare_parameter('KEY', 'v', sensitive=True)) + with pytest.raises(ValueError, match='mode'): + parameters.set_inherited_parameter_contexts(context, [], mode='append') + with pytest.raises(TypeError, match='inherited'): + parameters.set_inherited_parameter_contexts(context, context.id) + with pytest.raises(ValueError, match='inherit itself'): + parameters.set_inherited_parameter_contexts(context, [context]) + target = fix_context.generate(conftest.test_parameter_context_name + '_alias_target') + with pytest.raises(ValueError, match='reference itself'): + parameters.connect_parameter_provider_group(target, context.component.name, {'KEY': 'KEY'}) + + +def test_inherited_references_unreadable(): + """An inherited context the user cannot read has no component; keep it by id.""" + hidden = conftest.nipyapi.nifi.ParameterContextReferenceEntity(id='hidden', component=None) + context = ParameterContextEntity( + id='target', + component=conftest.nipyapi.nifi.ParameterContextDTO( + id='target', inherited_parameter_contexts=[hidden]), + ) + references = parameters._inherited_context_references(context, [], 'prepend', False, 'id') + assert [(item.id, item.component.id) for item in references] == [('hidden', 'hidden')] + + +def test_connect_parameter_provider_group_target_guards(fix_context, fix_pg): + """An unbound group and colliding context/group names must never pick a target.""" + group = fix_pg.generate() + source = fix_context.generate(group.component.name) + with pytest.raises(ValueError, match='bound'): + parameters.connect_parameter_provider_group(group, source.component.name, {}) + with pytest.raises(ValueError, match='exactly one'): + parameters.connect_parameter_provider_group(group.component.name, source.component.name, {}) + with pytest.raises(TypeError, match='mappings'): + parameters.connect_parameter_provider_group(group, source.component.name, ['API_KEY']) + + +def test_connect_parameter_provider_group_overwrites_local(fix_context, monkeypatch): + """Connecting replaces an existing sensitive literal and preserves other locals.""" + source = fix_context.generate(conftest.test_parameter_context_name + '_source') + parameters.upsert_parameter_to_context(source, parameters.prepare_parameter('API_KEY', 'secret', sensitive=True)) + target = fix_context.generate(conftest.test_parameter_context_name + '_target') + parameters.upsert_parameter_to_context(source, parameters.prepare_parameter('PLAIN', 'visible')) + parameters.upsert_parameter_to_context( + target, parameters.prepare_parameter('Alias', 'old', description='kept', sensitive=True)) + parameters.upsert_parameter_to_context(target, parameters.prepare_parameter('Untouched', 'keep')) + # NiFi leaves a sensitive alias to a non-sensitive parameter unresolved. + with pytest.raises(ValueError, match=r"not sensitive: \['PLAIN'\]"): + parameters.connect_parameter_provider_group(target, source.component.name, {'New': 'PLAIN'}) + submitted = [] + api = conftest.nipyapi.nifi.ParameterContextsApi + original_submit = api.submit_parameter_context_update + def capture_submit(handle, context_id, body, **kwargs): + submitted.append(body) + return original_submit(handle, context_id=context_id, body=body, **kwargs) + monkeypatch.setattr(api, 'submit_parameter_context_update', capture_submit) + result = parameters.connect_parameter_provider_group(target, source.component.name, {'Alias': 'API_KEY'}) + assert result.complete and not result.failure_reason + # The exact alias and inheritance travel in the same atomic request. + assert len(submitted) == 1 + component = submitted[0].component + assert [(item.parameter.name, item.parameter.value, item.parameter.sensitive) + for item in component.parameters] == [('Alias', '#{API_KEY}', True)] + assert [item.id for item in component.inherited_parameter_contexts] == [source.id] + live = parameters.get_parameter_context(target.id, 'id') + assert next(item.parameter.value for item in live.component.parameters + if item.parameter.name == 'Untouched') == 'keep' + assert next(item.parameter.description for item in live.component.parameters + if item.parameter.name == 'Alias') == 'kept' + with pytest.raises(ValueError, match='non-sensitive'): + parameters.connect_parameter_provider_group(target, source.component.name, {'Untouched': 'API_KEY'}) + # Confirm the server restriction behind the helper's preflight rejection. + live = parameters.get_parameter_context(target.id, 'id') + with pytest.raises(ApiException) as conversion: + original_submit( + api(), context_id=live.id, + body=ParameterContextEntity( + id=live.id, revision=live.revision, + component=conftest.nipyapi.nifi.ParameterContextDTO( + id=live.id, name=live.component.name, + parameters=[parameters.prepare_parameter('Untouched', '#{API_KEY}', sensitive=True)], + ), + ), + ) + assert conversion.value.status in (400, 409) + assert 'sensitive' in conversion.value.body.lower() + + +def test_apply_parameter_provider_group_selection(fix_param_provider, monkeypatch): + """Select requested groups; keep staged choices unless explicitly overridden. + + The environment-variable provider yields one group, so the multi-group staging + is simulated; the single-group live path is covered by the apply tests. + """ + nifi = conftest.nipyapi.nifi + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + fetched.component.parameter_group_configurations = [ + nifi.ParameterGroupConfigurationEntity( + group_name='selected', + parameter_sensitivities={'unset': None, 'staged': 'NON_SENSITIVE', 'override': 'NON_SENSITIVE'}, + ), + nifi.ParameterGroupConfigurationEntity( + group_name='kept', parameter_sensitivities={'p': 'SENSITIVE'}, synchronized=False), + nifi.ParameterGroupConfigurationEntity(group_name='unrelated', parameter_sensitivities={'other': None}), + ] + submitted = [] + def submit(handle, provider_id, body): + submitted.append(body) + return nifi.ParameterProviderApplyParametersRequestEntity( + request=nifi.ParameterProviderApplyParametersRequestDTO(request_id='selected-request')) + monkeypatch.setattr(nifi.ParameterProvidersApi, 'submit_apply_parameters', submit) + monkeypatch.setattr(nifi.ParameterProvidersApi, 'get_parameter_provider_apply_parameters_request', + lambda *args: nifi.ParameterProviderApplyParametersRequestEntity( + request=nifi.ParameterProviderApplyParametersRequestDTO(complete=True))) + monkeypatch.setattr(nifi.ParameterProvidersApi, 'delete_apply_parameters_request', lambda *args: None) + result = parameters.apply_parameter_provider( + provider, ['selected', 'kept'], sensitivities={'override': 'SENSITIVE'}, fetch_result=fetched, + ) + assert result.complete + assert len(submitted) == 1 + groups = submitted[0].parameter_group_configurations + assert [group.group_name for group in groups] == ['selected', 'kept'] + assert groups[0].group_name == groups[0].parameter_context_name == 'selected' + assert groups[0].parameter_sensitivities == { + 'unset': 'SENSITIVE', 'staged': 'NON_SENSITIVE', 'override': 'SENSITIVE', + } + # NiFi skips unsynchronized groups on apply: unset defaults to True, staged False is kept. + assert [group.synchronized for group in groups] == [True, False] + assert fetched.component.parameter_group_configurations[0].parameter_sensitivities['unset'] is None + parameters.apply_parameter_provider( + provider, ['selected', 'kept'], synchronized=True, fetch_result=fetched) + assert [group.synchronized for group in submitted[1].parameter_group_configurations] == [True, True] + with pytest.raises(TypeError, match='synchronized'): + parameters.apply_parameter_provider(provider, synchronized='yes', fetch_result=fetched) + # Override keys are parameter names; one matching no selected parameter must not be ignored. + with pytest.raises(ValueError, match=r"Unknown parameters.*\['other'\]"): + parameters.apply_parameter_provider( + provider, ['selected'], sensitivities={'other': 'SENSITIVE'}, fetch_result=fetched) + assert len(submitted) == 2 + + +def test_apply_parameter_provider_nothing_to_apply(fix_param_provider, caplog): + """NiFi completes an apply of only unsynchronized groups without changing anything.""" + provider = fix_param_provider.generate() + fetched = parameters.fetch_parameter_provider(provider) + group = fetched.component.parameter_group_configurations[0].group_name + with caplog.at_level('WARNING', logger='nipyapi.parameters'): + result = parameters.apply_parameter_provider( + provider, [group], synchronized=False, fetch_result=fetched) + assert result.complete and not result.failure_reason + assert 'nothing to apply' in caplog.text + assert parameters.get_parameter_context(group, greedy=False) is None + caplog.clear() + with caplog.at_level('WARNING', logger='nipyapi.parameters'): + parameters.apply_parameter_provider(provider, [group], fetch_result=fetched) + assert 'nothing to apply' not in caplog.text + assert parameters.get_parameter_context(group, greedy=False) is not None def test_create_parameter_context(fix_context): - if check_version('1.10.0') >= 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate(name=conftest.test_parameter_context_name) assert isinstance(c1, ParameterContextEntity) with pytest.raises(AssertionError): @@ -25,8 +566,6 @@ def test_create_parameter_context(fix_context): def test_get_parameter_context(fix_context): # Regression tests are parametrized, skip inside function to work properly - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") r1 = parameters.get_parameter_context('fake news', 'name') assert r1 is None c2 = parameters.get_parameter_context( @@ -44,8 +583,6 @@ def test_get_parameter_context(fix_context): def test_list_all_parameter_contexts(fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") _ = fix_context.generate() r1 = parameters.list_all_parameter_contexts() assert isinstance(r1, list) @@ -64,8 +601,6 @@ def test_list_all_parameter_contexts(fix_context): def test_list_orphaned_contexts(fix_context): """Test listing parameter contexts not bound to any process groups.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create an unbound context (orphan) orphan = fix_context.generate(name=conftest.test_basename + '_orphan') assert orphan is not None @@ -84,8 +619,6 @@ def test_list_orphaned_contexts(fix_context): def test_delete_parameter_context(fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() assert c1.revision is not None r1 = parameters.delete_parameter_context(c1) @@ -107,9 +640,17 @@ def test_delete_parameter_context(fix_context): assert r3.id == c3.id -def test_update_parameter_context(fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") +def test_update_parameter_context(fix_context, monkeypatch): + api = conftest.nipyapi.nifi.ParameterContextsApi + original_delete = api.delete_update_request + deleted = [] + + def record_delete(handle, context_id, request_id, **kwargs): + deleted.append((context_id, request_id)) + return original_delete(handle, context_id=context_id, request_id=request_id, **kwargs) + + # Pass-through spy: the real NiFi DELETE runs; only its IDs are recorded. + monkeypatch.setattr(api, 'delete_update_request', record_delete) c1 = fix_context.generate() c1.component.parameters.append( parameters.prepare_parameter('Black', 'Lives', 'Matter', True) @@ -119,6 +660,10 @@ def test_update_parameter_context(fix_context): ) assert isinstance(r1, ParameterContextEntity) assert 1 == len([x for x in r1.component.parameters if 'Black' in x.parameter.name]) + assert len(deleted) == 1 + with pytest.raises(ApiException) as gone: + api().get_parameter_context_update(*deleted[0]) + assert gone.value.status == 404 r1.component.parameters = [ parameters.prepare_parameter('Black', 'Votes', 'Matter', True) ] @@ -131,8 +676,6 @@ def test_update_parameter_context(fix_context): def test_rename_parameter_context(fix_context): """Test renaming a parameter context without affecting parameters.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create context with a parameter c1 = fix_context.generate() c1.component.parameters.append( @@ -154,8 +697,6 @@ def test_rename_parameter_context(fix_context): def test_delete_parameter_from_context(fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() c1.component.parameters.append( parameters.prepare_parameter('Black', 'Lives', 'Matter', True) @@ -168,8 +709,6 @@ def test_delete_parameter_from_context(fix_context): def test_upsert_parameter_to_context(fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() r1 = parameters.upsert_parameter_to_context( c1, @@ -179,8 +718,6 @@ def test_upsert_parameter_to_context(fix_context): def test_assign_context_to_process_group(fix_pg, fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() pg1 = fix_pg.generate() r1 = parameters.assign_context_to_process_group(pg1, c1.id) @@ -194,8 +731,6 @@ def test_assign_context_to_process_group(fix_pg, fix_context): def test_remove_context_from_process_group(fix_pg, fix_context): - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() pg1 = fix_pg.generate() r1 = parameters.assign_context_to_process_group(pg1, c1.id) @@ -211,8 +746,6 @@ def test_remove_context_from_process_group(fix_pg, fix_context): def test_upload_asset_from_bytes(fix_context): """Test uploading an asset from bytes - validates octet-stream handling.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -242,8 +775,6 @@ def test_upload_asset_from_bytes(fix_context): def test_list_assets(fix_context): """Test listing assets in a parameter context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -286,8 +817,6 @@ def test_list_assets(fix_context): def test_delete_asset(fix_context): """Test deleting an asset from a parameter context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -317,8 +846,6 @@ def test_delete_asset(fix_context): def test_prepare_parameter_with_asset(fix_context): """Test preparing a parameter that references an asset.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -350,8 +877,6 @@ def test_prepare_parameter_with_asset(fix_context): def test_prepare_parameter_with_multiple_assets(fix_context): """Test preparing a parameter that references multiple assets.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -389,8 +914,6 @@ def test_prepare_parameter_with_multiple_assets(fix_context): def test_prepare_parameter_with_asset_validation(): """Test validation errors for prepare_parameter_with_asset.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Cannot specify both single and multiple assets with pytest.raises(ValueError) as exc_info: @@ -428,8 +951,6 @@ def test_prepare_parameter_with_asset_validation(): def test_upload_asset_and_link_to_parameter(fix_context): """Test full workflow: upload asset and link it to a parameter.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") c1 = fix_context.generate() @@ -486,8 +1007,6 @@ def test_upload_asset_validation_errors(): def test_get_parameter_context_hierarchy_simple(fix_context): """Test get_parameter_context_hierarchy with a single context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -523,8 +1042,6 @@ def test_get_parameter_context_hierarchy_simple(fix_context): def test_get_parameter_context_hierarchy_with_inheritance(fix_context): """Test get_parameter_context_hierarchy with inherited contexts.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create child context (will be inherited) child_ctx = fix_context.generate(name=conftest.test_parameter_context_name + "_child") @@ -570,8 +1087,6 @@ def test_get_parameter_context_hierarchy_with_inheritance(fix_context): def test_get_parameter_context_hierarchy_not_found(): """Test get_parameter_context_hierarchy with invalid context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") import uuid with pytest.raises(ValueError, match="Parameter context not found"): @@ -580,8 +1095,6 @@ def test_get_parameter_context_hierarchy_not_found(): def test_get_parameter_context_hierarchy_include_bindings(fix_context, fix_pg): """Test get_parameter_context_hierarchy with include_bindings=True.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -615,8 +1128,6 @@ def test_get_parameter_context_hierarchy_include_bindings(fix_context, fix_pg): def test_get_parameter_context_hierarchy_exclude_parameters(fix_context): """Test get_parameter_context_hierarchy with include_parameters=False.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -643,8 +1154,6 @@ def test_get_parameter_context_hierarchy_exclude_parameters(fix_context): def test_get_parameter_context_hierarchy_bindings_only(fix_context, fix_pg): """Test get_parameter_context_hierarchy with bindings only (no parameters).""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create child context child_ctx = fix_context.generate(name=conftest.test_parameter_context_name + "_bind_child") @@ -693,8 +1202,6 @@ def test_get_parameter_context_hierarchy_bindings_only(fix_context, fix_pg): def test_get_parameter_context_hierarchy_defaults_backwards_compatible(fix_context): """Test that default behavior is backwards compatible.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -719,8 +1226,6 @@ def test_get_parameter_context_hierarchy_defaults_backwards_compatible(fix_conte def test_get_parameter_ownership_map(fix_context): """Test get_parameter_ownership_map with simple context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -755,8 +1260,6 @@ def test_get_parameter_ownership_map(fix_context): def test_get_parameter_ownership_map_with_inheritance(fix_context): """Test get_parameter_ownership_map tracks correct owning context.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") # Create child context with a parameter child_ctx = fix_context.generate(name=conftest.test_parameter_context_name + "_owner_child") @@ -792,8 +1295,6 @@ def test_get_parameter_ownership_map_with_inheritance(fix_context): def test_update_parameter_in_context(fix_context): """Test update_parameter_in_context updates existing parameter.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -818,8 +1319,6 @@ def test_update_parameter_in_context(fix_context): def test_update_parameter_in_context_not_found(fix_context): """Test update_parameter_in_context raises error for missing parameter.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -833,8 +1332,6 @@ def test_update_parameter_in_context_not_found(fix_context): def test_update_parameter_in_context_create_if_missing(fix_context): """Test update_parameter_in_context with create_if_missing=True.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -859,8 +1356,6 @@ def test_update_parameter_in_context_create_if_missing(fix_context): def test_update_parameter_in_context_invalid_context(): """Test update_parameter_in_context with invalid context raises error.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") import uuid with pytest.raises(ValueError, match="Parameter context not found"): @@ -919,8 +1414,6 @@ def test_prepare_parameter_update_description_only(): def test_prepare_parameter_unset_value_integration(fix_context): """Integration test: create param with value, then unset it.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() @@ -947,8 +1440,6 @@ def test_prepare_parameter_unset_value_integration(fix_context): def test_prepare_parameter_update_description_preserves_value(fix_context): """Integration test: update description without changing existing value.""" - if check_version('1.10.0') > 0: - pytest.skip("NiFi not 1.10+") ctx = fix_context.generate() diff --git a/tests/test_utils.py b/tests/test_utils.py index 7c595b67..30431619 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,5 +1,6 @@ """Tests for `nipyapi` _utils package.""" +import itertools import os import sys import pytest @@ -143,9 +144,123 @@ def test_filter_obj(fix_pg): assert r5 is None -def test_wait_to_complete(): - # TODO: Implement test - pass +def test_wait_to_complete(monkeypatch): + """Polling returns the truthy result, forwards arguments, and honors timing.""" + from types import SimpleNamespace + ticks = iter([0, 0, 1]) + sleeps = [] + calls = [] + result = object() + monkeypatch.setattr(utils, 'time', SimpleNamespace( + time=lambda: next(ticks), sleep=sleeps.append)) + + def check(value, *, marker): + calls.append((value, marker)) + return result if len(calls) == 2 else False + + assert utils.wait_to_complete(check, 'value', marker='test', + nipyapi_delay=0.25, nipyapi_max_wait=2) is result + assert calls == [('value', 'test'), ('value', 'test')] + assert sleeps == [0.25] + + +def test_wait_to_complete_timeout_and_error(): + """The existing polling utility propagates callback errors and raises on timeout.""" + def pending(): + return False + + with pytest.raises(ValueError, match='Timed Out'): + utils.wait_to_complete(pending, nipyapi_max_wait=0) + + def failed(): + raise RuntimeError('poll failed') + + with pytest.raises(RuntimeError, match='poll failed'): + utils.wait_to_complete(failed) + + +@pytest.mark.parametrize('scenario', [ + 'success', 'server', 'delete_error', 'server_delete_error', + 'timeout', 'poll_error', 'interrupt', +]) +def test_wait_for_request(scenario): + """Only observed completion allows cleanup; terminal failures retain precedence. + + Fake request states follow NiFi's StandardAsynchronousWebRequest: failures and + cancellations are reported as complete with failure_reason. + """ + entity_type = nifi.ParameterContextUpdateRequestEntity + dto_type = nifi.ParameterContextUpdateRequestDTO + events = [] + completed = dto_type(complete=True, failure_reason=( + 'request failed' if scenario in ('server', 'server_delete_error') else None)) + pending = dto_type(complete=False) + responses = (itertools.repeat(pending) if scenario == 'timeout' + else iter([pending, completed])) + poll_error = RuntimeError('poll failed') + delete_error = RuntimeError('delete failed') + + def get_request(): + events.append('poll') + if scenario == 'poll_error': + raise poll_error + if scenario == 'interrupt': + raise KeyboardInterrupt('interrupted') + return entity_type(request=next(responses)) + + def delete_request(): + events.append('delete') + if scenario in ('delete_error', 'server_delete_error'): + raise delete_error + + kwargs = {'nipyapi_delay': 0, 'nipyapi_max_wait': 0.05 if scenario == 'timeout' else 1} + if scenario in ('server', 'server_delete_error'): + with pytest.raises(ValueError, match='^request failed$'): + utils.wait_for_request(get_request, delete_request, **kwargs) + elif scenario in ('poll_error', 'delete_error'): + # Cleanup errors must not be confused with an exception in the caller. + try: + raise LookupError('unrelated caller error') + except LookupError: + with pytest.raises(RuntimeError) as failed: + utils.wait_for_request(get_request, delete_request, **kwargs) + assert failed.value is (poll_error if scenario == 'poll_error' else delete_error) + elif scenario == 'interrupt': + with pytest.raises(KeyboardInterrupt, match='interrupted'): + utils.wait_for_request(get_request, delete_request, **kwargs) + elif scenario == 'timeout': + with pytest.raises(ValueError, match='Timed Out'): + utils.wait_for_request(get_request, delete_request, **kwargs) + else: + assert utils.wait_for_request(get_request, delete_request, **kwargs) is completed + if scenario == 'timeout': + # A request polled while still pending is never deleted (DELETE would cancel it). + assert 'poll' in events and 'delete' not in events + elif scenario in ('interrupt', 'poll_error'): + assert events == ['poll'] + else: + assert events == ['poll', 'poll', 'delete'] + + +def test_wait_for_request_timing(monkeypatch): + """Delegate timing to the existing polling utility, with runtime defaults.""" + timings = [] + request = nifi.VerifyConfigRequestDTO(complete=True) + + def wait(check, **kwargs): + timings.append(kwargs) + return check() + + monkeypatch.setattr(utils, 'wait_to_complete', wait) + monkeypatch.setattr(conftest.nipyapi.config, 'short_retry_delay', 0.25) + monkeypatch.setattr(conftest.nipyapi.config, 'short_max_wait', 7) + get_request = lambda: nifi.VerifyConfigRequestEntity(request=request) + utils.wait_for_request(get_request, lambda: None) + utils.wait_for_request(get_request, lambda: None, nipyapi_delay=1, nipyapi_max_wait=99) + assert timings == [ + {'nipyapi_delay': 0.25, 'nipyapi_max_wait': 7}, + {'nipyapi_delay': 1, 'nipyapi_max_wait': 99}, + ] class TestIsUuid: